UTutila
Wallets

ListWalletAddresses

Changed on

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

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

Request

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.

filterstring

A filter expression that filters wallet addresses listed in the response.

Supported fields and functions:

NameDescriptionExample
addressFilter by one or more on-chain addresses (string...).address("0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6")
networkFilter by one or more networks (string...).network("networks/ethereum-mainnet")

Tip: combine a wildcard wallet (-) in the parent with the address filter to look up addresses across all wallets in a vault.

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"
    }
  ]
}

Changes

  • c4a910d79740Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the optional property // to the response with the status