Sign in

v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB
Wallets

ListWallets

Retrieve a list of all wallets in a vault.

get/v2/vaults/{vault_id}/wallets

Path parameters

vault_idstring required

Query parameters

view'BASIC' | 'FULL'

Whether to include the converted value (wallet.converted_value) in the response.

  • BASIC: The default view. Does not include the converted value.
  • FULL: Calculate and include the converted value and additional fields.
showArchivedboolean

Optional. When true, archived wallets are included together with non-archived wallets. When false or omitted, only non-archived wallets are returned.

filterstring

Filter results using EBNF syntax.

Supported fields:

  • displayName (with regex support)
  • createTime
  • external

Supported functions:

  • wallet_archived() - matches archived wallets. Takes no arguments. Use together with show_archived to get only archived wallets.

Examples:

  • displayName = "My Wallet" (All wallets with the display name "My Wallet")
  • regex(displayName, "^My ") (All wallets with names starting with "My ")
  • regex(displayName, "(?i)^mY ") (All wallets with names starting with "My ", case insensitive)
  • external, -external, NOT external
  • createTime > "2023-08-29T18:04:00Z"
  • createTime > "2023-08-29T18:04:00Z" AND displayName = "My Wallet"
  • wallet_archived() (Archived wallets only; set show_archived so archived wallets are returned)
orderBystring

SQL-like ordering specifications. Supports the fields

  • display_name
  • create_time
  • update_time
  • converted_value.amount (available through the FULL view).
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. Provide this to retrieve the subsequent page.

When paginating, all other parameters must match the call that provided the page token.

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.

includeReferencedResourcesboolean

Include referenced resources in the response.

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

{
  "wallets": [
    {
      "name": "vaults/1b25635a5b3f/wallets/95257c5a522f",
      "displayName": "DeFi wallet",
      "hasFrozenAssets": true,
      "networks": [
        "networks/ethereum-mainnet"
      ],
      "xrplDetails": {
        "signingPubKey": "ED5F5AC8B98974A3CA843326D9B88CEBD0560177B973EE0B149F782CFAA06DC66A"
      },
      "createParams": {
        "walletGroups": [
          "vaults/1b25635a5b3f/walletGroups/95257c5a522f"
        ]
      },
      "btcDetails": {
        "btcNetworkDetails": [
          {
            "network": "networks/bitcoin-mainnet"
          }
        ]
      }
    }
  ]
}