Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

List wallets by coin

Lists all your wallets for a specific asset.

get/api/v2/{coin}/wallet

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc

Query parameters

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the nextBatchPrevId value from the previous batch.

limitinteger

Maximum number of results to return. If the result set is truncated, use the nextBatchPrevId value to get the next batch.

allTokensboolean

Include data for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)

excludeSpendableBalanceboolean

Skip spendable balance calculations and only include confirmed balances. If absent, defaults to false.

searchLabelstring

Query for Wallets with a label containing this string

showAllWalletsboolean

Include wallets that have deleted or creationFailed set to true

Response

OK

nextBatchPrevIdstring uuid

When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the prevId query parameter.

totalCountinteger
coinstring required

A cryptocurrency or token ticker symbol.

Example response

{
  "wallets": [
    {
      "admin": {
        "policy": {
          "id": "59cd72485007a239fb00282ed480da1f",
          "rules": [
            {
              "coin": "btc",
              "condition": {
                "amountString": "2000000"
              },
              "action": {
                "userIds": [
                  "59cd72485007a239fb00282ed480da1f"
                ]
              }
            }
          ]
        }
      },
      "approvalsRequired": 1,
      "balanceString": "2000000",
      "buildDefaults": {
        "minFeeRate": 12000,
        "maxFeeRate": 18000,
        "feeMultiplier": 1.2,
        "changeAddressType": "p2wsh",
        "txFormat": "psbt",
        "autoReserveUnspentsOnBuildMins": 60
      },
      "coin": "btc",
      "coinSpecific": {
        "creationFailure": [
          "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26"
        ]
      },
      "custodialWalletId": "59cd72485007a239fb00282ed480da1f",
      "enterprise": "59cd72485007a239fb00282ed480da1f",
      "id": "59cd72485007a239fb00282ed480da1f",
      "keys": [
        "585951a5df8380e0e304a553",
        "585951a5df8380e0e30d645c",
        "585951a5df8380e0e30b6147"
      ],
      "label": "My Wallet",
      "m": 2,
      "n": 3,
      "nodeId": "59cd72485007a239fb00282ed480da1f",
      "receiveAddress": {
        "id": "59cd72485007a239fb00282ed480da1f",
        "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
        "chain": 1,
        "wallet": "59cd72485007a239fb00282ed480da1f",
        "coinSpecific": {
          "xlm": {
            "memoId": "1",
            "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
          },
          "txlm": {
            "memoId": "1",
            "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
          }
        },
        "balance": {
          "balance": 50000,
          "balanceString": "50000",
          "confirmedBalanceString": "40000",
          "spendableBalanceString": "40000"
        },
        "label": "Bob's Hot Wallet Address",
        "addressType": "p2sh"
      },
      "tags": [
        "59cd72485007a239fb00282ed480da1f"
      ],
      "spendableBalanceString": "2000000",
      "unspentCount": 100,
      "users": [
        {
          "user": "55e8a1a5df8380e0e30e20c6",
          "permissions": [
            "admin",
            "view",
            "spend"
          ]
        }
      ]
    }
  ],
  "nextBatchPrevId": "585951a5df8380e0e3063e9f",
  "coin": "btc"
}