v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB

Wallets

ListWalletAddresses

Retrieve a list of all wallet addresses of a specific wallet.

get/v2/vaults/{vault_id}/wallets/{wallet_id}/addresses

Path parameters

vault_idstring required

wallet_idstring required

Query parameters

pageSizeinteger

The maximum number of items to return. The service may return fewer than this value.

If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

A page token, received from the previous list call as nextPageToken.

skipinteger

How many results to skip.

Note: may be used alongside token-based pagination (see pageToken), although this won't be needed for most use cases.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSizeinteger

Total number of items in the response, regardless of pagination.

Example response

{
  "walletAddresses": [
    {
      "name": "vaults/1b25635a5b3f/wallets/67af44031584/addresses/519c67ddae33",
      "displayName": "Hal's Address 3",
      "network": "networks/bitcoin-mainnet",
      "address": "bc1q04pum57enmfgcu3tu5gwqlmza5n7tchky0gjvu",
      "key": "vaults/1b25635a5b3f/keys/95257c5a522f",
      "keyDerivationPath": [
        44,
        0,
        0,
        0,
        3
      ],
      "note": "This is a note"
    }
  ]
}