Získat API klíč
Přehled API · Subúčty

GET /v1/subaccounts/{externalClientRef}/account/balances

Stejný endpoint jako GET /v1/account/balances, pro subúčet z cesty.

Partnerský klíč s oprávněním subaccounts

Endpoint patří do sekce Subúčty. Vyžaduje partnerský API klíč (prefix pk_) s oprávněním subaccounts a podpis požadavku; klientský klíč dostane 403 INSUFFICIENT_PERMISSION. Postup je na stránkách Podpis požadavků a Klíč partnera.

Parametry cesty

ParametrPopis
externalClientRefpovinnéstringIdentifikátor klienta ve vašem systému přesně tak, jak jste ho poslali při založení subúčtu, včetně velikosti písmen: 1 až 64 písmen bez diakritiky, číslic, pomlček a podtržítek.

Odpověď

200 · application/json · BalancesResponse

Vyžaduje partnerský API klíč s oprávněním subaccounts a podepsaný požadavek. Funguje pro subúčet v každém stavu kromě zamítnutého; neexistující, cizí nebo zamítnutý subúčet vrací 404 CLIENT_NOT_FOUND.

Částky jsou desetinné řetězce s počtem míst dané měny, který se mezi měnami liší, proto je zpracujte jako desetinná čísla.

Měna s nulovým totalOwned i blokovaným zůstatkem se vynechává a seznam je seřazený podle kódu měny.

Blokovaná částka se dělí na heldInOrders a heldInWithdrawals; zbytek (například vklad držený ke kontrole) je held bez obou částí.

Prostředky ve stakingu jsou v poli staked a do total se nezapočítávají; totalOwned je total plus staked. Měna jen ve stakingu je v seznamu s nulovým available, held i total.

Staking se tu jen čte, zahájit ani ukončit ho přes API nelze.

Odpověď se neukládá do cache.

Částky a ceny jsou desetinné řetězce, aby nedocházelo ke ztrátě přesnosti.

PolePopis
itemspole BalanceResponseJedna položka na měnu, ve které účet drží dostupnou, blokovanou nebo stakovanou částku, seřazené podle kódu měny. Měny s nulovým totalOwned i blokovaným zůstatkem se vynechávají; měna jen ve stakingu v seznamu je.
items[].currencystringKód měny, například BTC nebo CZK.
items[].availablestringČástka, kterou lze hned použít, například k zadání pokynu nebo žádosti o výběr; desetinný řetězec v přesnosti měny.
items[].heldstringČástka, která je blokovaná: rezervovaná otevřenými pokyny, probíhajícími výběry nebo z jiného důvodu, například vklad držený ke kontrole; desetinný řetězec v přesnosti měny.
items[].totalstringDostupná plus blokovaná částka bez prostředků ve stakingu; desetinný řetězec.
items[].heldInOrdersstringČást held rezervovaná otevřenými pokyny; desetinný řetězec.
items[].heldInWithdrawalsstringČást held rezervovaná probíhajícími výběry; desetinný řetězec. Co z held zbude po odečtení heldInOrders a heldInWithdrawals, je blokované z jiného důvodu.
items[].stakedstringČástka ve stakingu včetně prostředků na cestě do stakingu a ve výpovědní lhůtě; desetinný řetězec. Do total se nezapočítává a pro pokyny ani výběry ji použít nelze.
items[].totalOwnedstringTotal plus staked, tedy vše, co účet v měně vlastní; desetinný řetězec.

Chyby

Chyby mají formát application/problem+json; zpracovávejte je podle pole code. Podrobnosti najdete v přehledu chyb.

StavKódyŘešení
401MISSING_API_KEY, INVALID_API_KEY, SIGNATURE_REQUIRED, INVALID_SIGNATURE, TIMESTAMP_OUT_OF_WINDOWDoplňte hlavičku X-COINERO-APIKEY. Ověřte hodnotu a stav klíče i aktivitu účtu. Doplňte hlavičky X-COINERO-TIMESTAMP a X-COINERO-SIGNATURE podle stránky Podpis požadavků. Zkontrolujte kanonický řetězec (časová značka, metoda velkými písmeny, cesta s dotazem, tělo bajt po bajtu) a že secret před HMAC dekódujete z Base64; stránka Podpis požadavků má referenční vektor. Použijte aktuální čas v milisekundách; pole serverTime a serverTimeMs v odpovědi nesou čas serveru, podle kterého opravte hodiny klienta.
403INSUFFICIENT_PERMISSION, IP_NOT_ALLOWEDPole requiredPermission uvádí, které oprávnění chybí. Oprávnění klíče nelze změnit; vytvořte nový klíč s potřebným oprávněním. Odešlete požadavek z adresy povolené u klíče, nebo vytvořte nový klíč, jehož seznam adresu obsahuje; seznam nelze dodatečně změnit.
404CLIENT_NOT_FOUNDOvěřte externalClientRef včetně velikosti písmen; neexistující, cizí i zamítnutý subúčet vracejí stejnou chybu. Subúčet založte přes POST /v1/subaccounts.
405METHOD_NOT_ALLOWEDPoužijte metodu z hlavičky Allow: GET a HEAD ke čtení, POST a DELETE jen u operací, které je mají v dokumentaci.
429RATE_LIMIT_EXCEEDEDPřed dalším pokusem vyčkejte počet sekund z Retry-After.