v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB

Vaults

List vaults

Permissions required: Read vault activity

List vault metadata including name, ID, description, and assets.

NOTE: price and USD value information is recent but does not reflect real-time data.

get/vaults

Query parameters

afterIdstring

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

limitinteger

Maximum number of results to return per query

Response

A list of vaults and their metadata

Example response

{
  "data": [
    {
      "vaultId": "1c920f4241b78a1d483a29f3c24b6c4c",
      "name": "Long Hold Vault",
      "description": "For long-term investments",
      "type": "VAULT",
      "accountName": "Account name",
      "assets": [
        {
          "walletId": "3d293c0d64c703023692216e9b4f5280",
          "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"
          },
          "vaultId": "1c920f4241b78a1d483a29f3c24b6c4c",
          "vaultName": "Long Hold Vault"
        }
      ]
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}