v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB

Wallets

List all wallets for all vaults

Permissions required: Read vault activity

List wallet metadata for the current user.

get/wallets

Query parameters

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

subaccountIdsstring[]

If subaccountIds filter is present, only wallets linked to those subaccountIds will be returned.

networkIdstring

If set, only wallets for this Network ID will be returned

assetTypestring

If set, only wallets for this Asset Type ID will be returned

limitinteger

Maximum number of results to return per query

filterByIsArchivedboolean

Filter by the whether a wallet is archived. If true, then only archived wallets will be returned. If false, then only not-archived wallets are returned. If not specified, then all wallets are returned.

searchByAddressstring

Search wallets based on addresses in this wallet. The search length should be at least 3 characters.

Response

List of wallets for this vault

Example response

{
  "data": [
    {
      "walletId": "3d293c0d64c703023692216e9b4f5280",
      "walletName": "Bitcoin Mainnet - Wallet 1",
      "depositAddress": {
        "address": "2N19AcihQ1a4MxQW658UFHTioUNnMkiHPkw",
        "addressId": "a33f83d96ca95cac000a344aa478a8b8",
        "addressSignaturePayload": "7b225465787441646472657373223a22324e313941636968513161344d78515736353855464854696f554e6e4d6b6948506b77227d",
        "signature": "1642000aa9cca8e8610981aefbdb204b361c9dca3fa067b88fdacfba7a0f620d721378a33f4bbadad3923e633a4d712646d1e8e314e9fcb4aa4102c0581f6503"
      },
      "assets": [
        {
          "assetType": "BTC",
          "availableBalance": {
            "quantity": "10.00000000",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "97510.1"
          },
          "totalBalance": {
            "quantity": "10.45234733",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "101920.94"
          },
          "stakedBalance": {
            "quantity": "32.00000000",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "312032.32"
          },
          "unclaimedBalance": {
            "quantity": "0",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "0"
          },
          "unvestedBalance": {
            "quantity": "0",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "0"
          },
          "unvestedUnstakeableBalance": {
            "quantity": "0",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "0"
          }
        }
      ],
      "vaultId": "1c920f4241b78a1d483a29f3c24b6c4c",
      "vaultName": "Long Hold Vault",
      "isDefault": true,
      "isArchived": false,
      "networkId": "BTC",
      "type": "WALLET"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}