List vault asset balances - Kraken Developers

curl --request GET \ --url https://api.kraken.com/v0/insto/custody/vaults/{vault_id}/assets/balances \ --header 'api-key: <api-key>' \ --header 'api-nonce: <api-key>' \ --header 'api-otp: <api-key>' \ --header 'api-sign: <api-key>'

[ { "asset": "BTC", "asset_class": "currency", "name": "Bitcoin", "name_full": "Bitcoin", "symbol": "BTC", "decimals": 8, "display_decimals": 8, "rate_decimals": 8, "funding_decimals": 8, "min_lot": "0.00010000", "reserve": false, "virtual": true, "metadata": { "color_code": "#F7931A" }, "balance": "1.50000000", "balance_diff": "0.10000000", "spot": "1.50000000", "hold": "0.00000000", "available": "1.50000000", "pledged": "0.00000000", "quote_balance": "97500.00", "quote_spot_balance": "97500.00", "quote_available": "97500.00", "quote_price": "65000.00", "quote_asset": "USD", "quote_asset_class": "currency" }, { "asset": "USD", "asset_class": "currency", "name": "US Dollar", "name_full": "US Dollar", "symbol": "USD", "decimals": 4, "display_decimals": 2, "rate_decimals": 4, "funding_decimals": 4, "min_lot": "0.0100", "reserve": false, "virtual": false, "metadata": { "color_code": "#85BB65" }, "balance": "10000.0000", "spot": "10000.0000", "hold": "0.0000", "available": "10000.0000", "quote_balance": "10000.00", "quote_spot_balance": "10000.00", "quote_available": "10000.00", "quote_price": "1.0000", "quote_asset": "USD", "quote_asset_class": "currency" } ]

Authorizations

api-key

string

header

required

api-sign

string

header

required

api-nonce

string

header

required

api-otp

string

header

required

Path Parameters

vault_id

string

required

Vault identifier, a V-prefixed 14-char base32 string with a final check character.

Example:

"VABCDEF234567A"

Query Parameters

quote

string

Currency code used to value quote fields on each row. Defaults to USD when omitted; only USD is currently accepted.

Example:

"USD"

full_precision

enum<string>

When "true", numeric balance strings keep full upstream precision instead of being rounded to the asset's funding_decimals.

Available options:

true,

false

Example:

"true"

Response

OK. Returns per-asset balances for the vault. The response is a JSON array of balance rows.

asset

string

required

Asset code (e.g. BTC, USD, AAPLX).

Example:

"BTC"

asset_class

string

required

Asset class wire label for the row asset (e.g. currency, tokenised_asset).

Example:

"currency"

name

string

required

Short display name of the asset.

Example:

"Bitcoin"

name_full

string

required

Full display name of the asset.

Example:

"Bitcoin"

symbol

string

required

Trading or display symbol for the asset.

Example:

"BTC"

decimals

number<double>

required

Maximum decimal precision for the asset.

Example:

8

display_decimals

number<double>

required

Decimal places used when displaying the asset in the UI.

Example:

8

rate_decimals

number<double>

required

Decimal places used for exchange rates involving the asset.

Example:

8

funding_decimals

number<double>

required

Decimal places used for funding amounts; balances are rounded to this unless full_precision=true.

Example:

8

min_lot

string

required

Minimum tradable or transferable lot size as a fixed-precision decimal string.

Example:

"0.00010000"

reserve

boolean

required

Whether the asset is a reserve asset.

Example:

false

virtual

boolean

required

Whether the asset is crypto/virtual (true) or fiat (false).

Example:

true

metadata

object

required

Asset-specific display metadata.

Show child attributes

balance

string

required

Total balance for this asset in the vault, as a fixed-precision decimal string.

Example:

"1.50000000"

spot

string

required

Spot balance component for this asset, as a fixed-precision decimal string.

Example:

"1.50000000"

hold

string

required

Balance on hold (e.g. pending withdrawals), as a fixed-precision decimal string.

Example:

"0.00000000"

available

string

required

Available balance for this asset, as a fixed-precision decimal string.

Example:

"1.50000000"

quote_asset

string

required

Quote asset code used to value the quote fields (e.g. USD). Defaults to USD when the quote parameter is omitted.

Example:

"USD"

quote_asset_class

string

required

Quote asset class wire label. Currently always currency.

Example:

"currency"

launch_time

string | null

Unix timestamp (seconds) when the asset launched, when applicable.

Example:

"1700000000"

balance_diff

string | null

Day-over-day balance delta for this asset; null when no prior reference exists.

Example:

"0.10000000"

pledged

string | null

Pledged balance component, when applicable; otherwise null.

Example:

"0.00000000"

quote_balance

string | null

Total balance valued in the quote currency; null when no quote rate is available.

Example:

"97500.00"

quote_spot_balance

string | null

Spot balance valued in the quote currency; null when no quote rate is available.

Example:

"97500.00"

quote_available

string | null

Available balance valued in the quote currency; null when no quote rate is available.

Example:

"97500.00"

quote_price

string | null

Price of one unit of the asset in the quote currency; null when no quote rate is available.

Example:

"65000.00"