Přehled API · Subúčty
GET /v1/subaccounts/{externalClientRef}
Vrací stav subúčtu, jeho limity se zbývajícím denním limitem, povolené trhy a kontakt.
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
| Parametr | Popis |
|---|---|
| externalClientRefpovinnéstring | Identifiká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 · SubaccountResponseLimity jsou v korunách; zbývající denní limit platí pro dnešní den podle pražského času.
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.
Odpověď se neukládá do cache.
Částky a ceny jsou desetinné řetězce, aby nedocházelo ke ztrátě přesnosti.
| Pole | Popis |
|---|---|
| externalClientRefstring | Identifikátor klienta ve vašem systému, jak byl uložen při založení. |
| statusstring | Stav subúčtu. Hodnoty: review, active, blocked, rejected, closed. |
| createdAtstring | Kdy subúčet vznikl, ISO 8601, UTC. |
| createdAtMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| activatedAtstring nebo null | Kdy byl subúčet naposledy aktivován, ISO 8601, UTC; null, pokud nikdy. Pole je v odpovědi vždy. |
| activatedAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. |
| closedAtstring nebo null | Kdy byl subúčet ukončen, ISO 8601, UTC; null, dokud ukončený není. Pole je v odpovědi vždy. |
| closedAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Případně null. |
| updatedAtstring | Kdy se subúčet naposledy změnil (stav nebo kontakt), ISO 8601, UTC. Podle něj GET /v1/subaccounts řadí a filtruje: nejnovější přečtená hodnota je updatedAfter vašeho dalšího čtení. V události webhooku je to okamžik události, nikdy pozdější než hodnota v seznamu. |
| updatedAtMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| limitsSubaccountLimitsResponse | Limity pokynů vašeho partnerského účtu, které platí pro subúčet. |
| limits.minOrderAmountApiMoney | Nejmenší pokyn v korunách. |
| limits.minOrderAmount.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| limits.minOrderAmount.currencystring | Kód měny částky, například BTC nebo CZK. |
| limits.maxOrderAmountApiMoney nebo null | Největší pokyn v korunách; null bez horní meze. Pole je v odpovědi vždy. |
| limits.maxOrderAmount.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| limits.maxOrderAmount.currencystring | Kód měny částky, například BTC nebo CZK. |
| limits.dailyLimitApiMoney | Denní limit pokynů jednoho klienta v korunách. |
| limits.dailyLimit.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| limits.dailyLimit.currencystring | Kód měny částky, například BTC nebo CZK. |
| limits.dailyLimitRemainingApiMoney | Zbývající část denního limitu pro dnešní den podle pražského času, v korunách. Zrušené a odmítnuté pokyny se nepočítají. |
| limits.dailyLimitRemaining.amountstring | Částka jako desetinný řetězec s tečkou a nejméně s tolika místy, kolik má její měna. Zpracujte ji jako desetinné číslo, ne jako číslo s pohyblivou řádovou čárkou. |
| limits.dailyLimitRemaining.currencystring | Kód měny částky, například BTC nebo CZK. |
| allowedMarketspole string | Trhy, na kterých subúčet smí obchodovat: kryptoměny, které partner nabízí, proti jeho měně vypořádání, například BTCCZK. |
| contactSubaccountContactResponse | Kontakt klienta, jak jste ho poslali. |
| contact.emailstring nebo null | Kontaktní e-mail klienta, nebo null. Pole je v odpovědi vždy. |
| contact.phonestring nebo null | Kontaktní telefon klienta v mezinárodním tvaru, nebo null. Pole je v odpovědi vždy. |
Hodnoty stavů
Nové hodnoty mohou přibýt i v rámci v1; neznámou hodnotu zpracujte bez selhání.
| PublicSubaccountStatus | Význam |
|---|---|
review | subúčet čeká na posouzení Coinerem a zatím nemůže obchodovat |
active | subúčet může obchodovat |
blocked | Coinero subúčet zablokovalo a ten nemůže obchodovat; důvod se nesděluje |
rejected | aktivace subúčtu byla trvale zamítnuta; detail a endpointy pod prefixem subúčtu ho vracejí jako 404, objeví se v seznamu GET /v1/subaccounts a v odpovědi opakovaného založení |
closed | subúčet je ukončený a nemůže obchodovat ani se měnit; data jdou dál číst a znovu otevřít ho nejde |
Chyby
Chyby mají formát application/problem+json; zpracovávejte je podle pole code. Podrobnosti najdete v přehledu chyb.
| Stav | Kódy | Řešení |
|---|---|---|
| 401 | MISSING_API_KEY, INVALID_API_KEY, SIGNATURE_REQUIRED, INVALID_SIGNATURE, TIMESTAMP_OUT_OF_WINDOW | Doplň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. |
| 403 | INSUFFICIENT_PERMISSION, IP_NOT_ALLOWED | Pole 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. |
| 404 | CLIENT_NOT_FOUND | Ověř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. |
| 405 | METHOD_NOT_ALLOWED | Použijte metodu z hlavičky Allow: GET a HEAD ke čtení, POST a DELETE jen u operací, které je mají v dokumentaci. |
| 429 | RATE_LIMIT_EXCEEDED | Před dalším pokusem vyčkejte počet sekund z Retry-After. |