Obchodní API
Stav služby
Jak číst GET /v1/status: komponenty, jejich hodnoty a pravidlo, podle kterého se skládá souhrn.
Dvě místa se stavem.
GET /v1/status ukazuje stav tržních dat a brány z pohledu API a vyžaduje klíč. Provoz Coinera jako celku, včetně aplikace, sleduje veřejná stránka stavu, která běží mimo naši infrastrukturu.
Odpověď
Pole status je souhrn, api stav samotné aplikace (operational nebo maintenance) a components obsahuje stav šesti komponent. Pole maintenance popisuje ohlášenou odstávku, jinak je null, a lastUpdatedAt je čas poslední aktualizace tržních dat, nebo null, když stav dat neznáme.
Hodnoty
| Hodnota | Význam |
|---|---|
operational | plně funkční; hrstka nelikvidních párů dočasně doplňovaná náhradní cestou se sem počítá taky |
degraded | omezený provoz: náhradní zdroj pro celý trh, nebo pro víc než čtvrtinu párů |
outage | výpadek nebo příliš stará data |
maintenance | plánovaná údržba |
disabled | komponenta je vypnutá konfigurací, ne porouchaná; celkový stav nikdy nesnižuje |
Komponenty
| Komponenta | Co popisuje | degraded | outage |
|---|---|---|---|
ticker | Cenová data, ze kterých čtou GET /v1/ticker, GET /v1/tickers a odhad pokynu. | Data chodí náhradní cestou s delší latencí, nebo jsou zastaralá víc než u čtvrtiny párů. | Stav dat neznáme, nebo je poslední aktualizace starší než 5 minut. |
depth | Kniha pokynů, GET /v1/depth. | Jako u tickeru. | Jako u tickeru, a navíc výpadek odběru knih: snímky platí 30 s, takže endpoint vrací 503. |
trades | Veřejné obchody, GET /v1/trades. | Jako u tickeru, a navíc výpadek odběru obchodů: poslední obchody zůstávají k dispozici, ale nové nepřibývají. | Jako u tickeru. |
ohlc | Svíčky, GET /v1/ohlc. | Jako u tickeru. | Jako u tickeru. |
stream | WebSocket brána /v1/ws. | Neběží odběr některého ze zdrojů dat streamu. Spojení zůstávají a dostávají snapshot, ale updaty nemusí chodit. | Komponenta tuto hodnotu nenabývá. |
subaccounts | Partnerská část API: subúčty, pokyny za subúčet, report a webhooky (jen pro partnery). | Obchodování přes API je vypnuté nebo nemá spojení na zpracování pokynů: pokyny nejdou, čtení a aktivace subúčtů ano. | Komponenta tuto hodnotu nenabývá. |
- Komponenty
depth,tradesaohlcmají hodnotudisabled, když Coinero referenční tržní data provozně vypne. Komponentastreamjedisabled, když je brána vypnutá, amaintenancev ohlášené údržbě. Kanálybookatradesstreamu se zapínají spolu s endpointy. Jejich vypnutí hlásí komponentydepthatrades, nestream. - Komponenta
subaccountsjemaintenancepři odstávce API nebo při vypnuté partnerské části (zápisové endpointy partnerů pak vracejí 503SERVICE_MAINTENANCE) a jinakoperationalnebodegraded. Hodnotudisablednenabývá. - Počet otevřených spojení WebSocketu se nevydává.
Souhrn
Souhrn status je nejhorší stav z pole api a z komponent, s těmito pravidly:
- Ohlášená odstávka (
api: maintenance) přebíjí všechno: souhrn jemaintenance. Klient má čekat do konce okna, ne hlásit incident. - Komponenty
disabledamaintenancese do souhrnu nepočítají. Vypnutá komponenta není porucha. tickerse do souhrnu počítá plně, i ve stavuoutage. Bez cen se obchodovat nedá.- Komponenty
depth,trades,ohlcastreamzhorší souhrn nejvýš nadegraded. Jejichoutagese v souhrnu zobrazí jakodegraded, aby váš robot nepřestal obchodovat kvůli referenčním datům nebo streamu, které k obchodování nepotřebuje. - Komponenta
subaccountssouhrn nejvýš zhorší nadegraded. Jejímaintenancesouhrn nemění, protože klientská část API běží: souhrnmaintenanceurčuje jen poleapi.
Partneři: kdo komponentu sleduje.
Komponentu
subaccounts doporučujeme číst v aplikaci partnera a podle ní vypínat zadávání pokynů. Při degraded pokyny neposílejte, čtení a aktivace subúčtů běží. Při maintenance nevolejte zápisy; při odstávce celého API (pole api) vrací 503 i čtení. Plánované okno odstávky nese pole maintenance (from, to, description); partneři s webhooky ho dostanou navíc událostmi service.maintenance a service.resumed. Postup viz Pokyny za subúčet.Co číst, když něco hlídáte.
Obchodující robot sleduje
status a komponentu ticker. Graf nebo analýza čte komponenty depth, trades a ohlc. Klient, který odebírá WebSocket, sleduje stream. Doporučený interval dotazování je 60 s, viz Limity požadavků.