Saltar al contenido principal

Balances

GET /v2/balances

List the account asset balances

Respuestas

CódigoDescripciónCuerpo
200Éxito.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

Parámetros

ParámetroEnTipoRequeridoDescripción
assetSymbolpathstringThe 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.

Respuestas

CódigoDescripciónCuerpo
200Éxito.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).

Esquemas

BalanceResource

CampoTipoDescripción
assetSymbolstringEj.: BTC.
balancestringEj.: 500.
balanceFrozenstringEj.: 0.
balancePendingstringEj.: 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. Ej.: 500.
balanceUSDstringEj.: 0.62.
balanceCapacityTotal (opcional)string
balanceCapacityAvailable (opcional)string
balanceCapacitySpent (opcional)string

HistoricalBalancePoint

CampoTipoDescripción
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. Ej.: 500.62.

HistoricalBalancesResponse

CampoTipoDescripción
assetSymbolstringEj.: BTC.
granularityday | week | month
startDatestring | null
endDatestring | null
dataHistoricalBalancePoint[]
paginationPaginationMeta

PaginationMeta

CampoTipoDescripción
pagenumberEj.: 1.
limitnumberEj.: 25.
totalItemsnumberEj.: 100.
totalPagesnumberEj.: 4.

Problem

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

Volver a la referencia de endpoints. Ver también: Paginación · Errores · Ids y correlación.