Skip to main content
GET
Get vault balance

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
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_asset
string

Currency code used to value the vault balance. Defaults to USD when omitted; only USD is currently accepted.

Example:

"USD"

Response

OK. Returns the vault balance valued in the requested quote currency.

quote_value
string
required

Total vault balance valued in the quote currency, decimal as string.

Example:

"12345.6789"

quote_value_change_24h
string
required

24h percentage change of the vault's quote-valued spot balance versus the prior day, as a percentage string (not a quote-currency amount).

Example:

"1.50"

missing_rates
object[]
required

Assets held in the vault for which a quote rate was unavailable when computing the total.

quote_asset
string
required

Quote asset code the balance fields are valued in (e.g. USD). Defaults to USD when the quote_asset parameter is omitted. Currency-only by contract.

Example:

"USD"