v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB

Balances

QueryBalances

Retrieve a list of all asset balances in all wallets in a vault.

post/v2/vaults/{vault_id}:queryBalances

Path parameters

vault_idstring required

Request body

filterstring

Filter results using EBNF syntax.

Supported functions:

asset(asset_name) (example: asset("assets/native.ethereum-mainnet"))
network(network_name) (example: network("networks/ethereum-mainnet"))
wallet_external() (example: wallet_external())

pageSizeinteger

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

pageTokenstring

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

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.

referencedResourcesobject

A mapping of the referenced resources in the message. The key is the resource name and the value is the corresponding resource.

Example response

{
  "balances": [
    {
      "asset": "assets/native.ethereum-mainnet",
      "value": "1.3",
      "rawValue": "13000000",
      "frozenValue": "0.3"
    }
  ]
}