Skip to main content

Balances

GET /v2/balances

List the account asset balances

Responses

CodeDescriptionBody
200Success.object
401application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).
403application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).
429application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).
500application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).
502application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).
503application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).

GET /v2/balances/{assetSymbol}/history

Historical balances for an asset

Parameters

ParameterInTypeRequiredDescription
assetSymbolpathstringyesThe asset code published as assetSymbol by GET /v2/assets.
pagequeryintegernoDefault: 1.
limitqueryintegernoDefault: 25.
startDatequerystringnoISO-8601 start date. Defaults to the first movement.
endDatequerystringnoISO-8601 end date. Defaults to now.
granularityqueryday | week | monthnoDefault: day.

Responses

CodeDescriptionBody
200Success.HistoricalBalancesResponse
401application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).
403application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).
404application/problem+json (RFC 9457) — branch on code, not on the status: not_found (not retryable).
429application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).
500application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).
502application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).
503application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).

Schemas

BalanceResource

FieldTypeDescription
assetSymbolstringe.g. BTC.
balancestringe.g. 500.
balanceFrozenstringe.g. 0.
balancePendingstringe.g. 100.
balancePrefCurrencystringThis balance converted to the account's preferred currency. The unit is not repeated here — read preferredCurrency from GET /v2/account. Named for its unit, like balanceUSD. e.g. 500.
balanceUSDstringe.g. 0.62.
balanceCapacityTotal (optional)string
balanceCapacityAvailable (optional)string
balanceCapacitySpent (optional)string

HistoricalBalancePoint

FieldTypeDescription
datestring
balancestringBalance at the end of the period, as an exact decimal string in plain notation — never exponential. Truncated to the asset operating precision. Parse it as a decimal, not a float. e.g. 500.62.

HistoricalBalancesResponse

FieldTypeDescription
assetSymbolstringe.g. BTC.
granularityday | week | month
startDatestring | null
endDatestring | null
dataHistoricalBalancePoint[]
paginationPaginationMeta

PaginationMeta

FieldTypeDescription
pagenumbere.g. 1.
limitnumbere.g. 25.
totalItemsnumbere.g. 100.
totalPagesnumbere.g. 4.

Problem

FieldTypeDescription
typestringStable problem-type URI. Resolves to docs for this error. e.g. https://docs.skipo.com/errors/rate_limited.
titlestringShort, human-readable summary (stable, English). e.g. Rate limit exceeded.
statusnumberHTTP status code. e.g. 429.
codestringStable machine-readable error code (equals the last path segment of type). e.g. rate_limited.
retryablebooleanWhether retrying the identical request may succeed. e.g. true.
detail (optional)stringHuman-readable, possibly localized detail.
instance (optional)stringThe request path that produced the error.
traceId (optional)stringTrace id — joins BigQuery api_request and Cloud Logging.

Back to the endpoint reference. See also: Pagination · Errors · Ids and correlation.