Balances
GET /v2/balances
List the account asset balances
Responses
| Code | Description | Body |
|---|---|---|
200 | Success. | object |
401 | application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable). | — |
403 | application/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). | — |
429 | application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable). | — |
500 | application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable). | — |
502 | application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable). | — |
503 | application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable). | — |
GET /v2/balances/{assetSymbol}/history
Historical balances for an asset
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
assetSymbol | path | string | yes | The asset code published as assetSymbol by GET /v2/assets. |
page | query | integer | no | Default: 1. |
limit | query | integer | no | Default: 25. |
startDate | query | string | no | ISO-8601 start date. Defaults to the first movement. |
endDate | query | string | no | ISO-8601 end date. Defaults to now. |
granularity | query | day | week | month | no | Default: day. |
Responses
| Code | Description | Body |
|---|---|---|
200 | Success. | HistoricalBalancesResponse |
401 | application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable). | — |
403 | application/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). | — |
404 | application/problem+json (RFC 9457) — branch on code, not on the status: not_found (not retryable). | — |
429 | application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable). | — |
500 | application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable). | — |
502 | application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable). | — |
503 | application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable). | — |
Schemas
BalanceResource
| Field | Type | Description |
|---|---|---|
assetSymbol | string | e.g. BTC. |
balance | string | e.g. 500. |
balanceFrozen | string | e.g. 0. |
balancePending | string | e.g. 100. |
balancePrefCurrency | string | This 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. |
balanceUSD | string | e.g. 0.62. |
balanceCapacityTotal (optional) | string | |
balanceCapacityAvailable (optional) | string | |
balanceCapacitySpent (optional) | string |
HistoricalBalancePoint
| Field | Type | Description |
|---|---|---|
date | string | |
balance | string | Balance 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
| Field | Type | Description |
|---|---|---|
assetSymbol | string | e.g. BTC. |
granularity | day | week | month | |
startDate | string | null | |
endDate | string | null | |
data | HistoricalBalancePoint[] | |
pagination | PaginationMeta |
PaginationMeta
| Field | Type | Description |
|---|---|---|
page | number | e.g. 1. |
limit | number | e.g. 25. |
totalItems | number | e.g. 100. |
totalPages | number | e.g. 4. |
Problem
| Field | Type | Description |
|---|---|---|
type | string | Stable problem-type URI. Resolves to docs for this error. e.g. https://docs.skipo.com/errors/rate_limited. |
title | string | Short, human-readable summary (stable, English). e.g. Rate limit exceeded. |
status | number | HTTP status code. e.g. 429. |
code | string | Stable machine-readable error code (equals the last path segment of type). e.g. rate_limited. |
retryable | boolean | Whether retrying the identical request may succeed. e.g. true. |
detail (optional) | string | Human-readable, possibly localized detail. |
instance (optional) | string | The request path that produced the error. |
traceId (optional) | string | Trace id — joins BigQuery api_request and Cloud Logging. |
Back to the endpoint reference. See also: Pagination · Errors · Ids and correlation.