Získat API klíč
Přehled API · Obecné

GET /v1/status

Vrací stav API a dostupnost tržních dat.

Parametry dotazu

Endpoint nemá parametry dotazu.

Odpověď

application/json · ServiceStatusResponse

Endpoint odpovídá i při výpadku tržních dat nebo plánované údržbě; API klíč a limity platí i zde.

Stav degraded znamená plošný problém: náhradní zdroj pro celý trh, nebo zastaralá data u víc než čtvrtiny párů. Pár, u kterého burza chvíli neposlala aktualizaci, se doplní náhradní cestou dřív, než se za zastaralý považuje, takže stav nemění.

Odpověď se neukládá do cache.

PolePopis
statusstringBěhem údržby maintenance, jinak nejhorší stav API a jeho komponent. Hodnoty: operational, degraded, outage, maintenance.
apistringStav samotného API: operational, během údržby maintenance. Hodnoty: operational, degraded, outage, maintenance.
componentsServiceComponentsResponseStavy jednotlivých komponent API.
components.tickerstringStav zdroje cen: degraded při náhradním zdroji pro celý trh nebo když je u víc než čtvrtiny párů cena starší než pět minut, outage při zpoždění celého zdroje přes pět minut. Nelikvidní pár, který burza chvíli neaktualizuje, se doplní náhradní cestou dřív a stav nemění. Hodnoty: operational, degraded, outage, maintenance.
maintenanceMaintenanceWindowResponse nebo nullOznámená údržba, jinak null; pole je vždy přítomné.
maintenance.fromstringZačátek údržby v ISO 8601, UTC.
maintenance.fromMsinteger (int64)Stejný okamžik jako Unix timestamp v milisekundách.
maintenance.tostringPředpokládaný konec údržby v ISO 8601, UTC.
maintenance.toMsinteger (int64)Stejný okamžik jako Unix timestamp v milisekundách.
maintenance.descriptionstringPopis údržby v angličtině, jak jej vrací API.
lastUpdatedAtnull nebo stringPoslední aktualizace tržních dat v ISO 8601, UTC; null, pokud stav zdroje není znám. Rozdíl oproti serverTime určuje stáří dat.
lastUpdatedAtMsnull nebo integerStejný okamžik jako Unix timestamp v milisekundách, případně null.
serverTimestringAktuální čas serveru v ISO 8601, UTC, s milisekundami.
serverTimeMsinteger (int64)Stejný okamžik jako Unix timestamp v milisekundách.

Hodnoty stavů

Nové hodnoty mohou přibýt i v rámci v1; neznámou hodnotu zpracujte bez selhání.

PublicServiceStatusVýznam
operationalplně funkční; hrstka nelikvidních párů dočasně doplňovaná náhradní cestou se sem počítá taky
degradedomezený provoz: náhradní zdroj pro celý trh, nebo pro víc než čtvrtinu párů
outagevýpadek nebo příliš stará data
maintenanceplánovaná údržba

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_KEYDoplňte hlavičku X-COINERO-APIKEY. Ověřte hodnotu a stav klíče i aktivitu účtu.
405METHOD_NOT_ALLOWEDPoužijte metodu z hlavičky Allow; veřejné API je jen pro čtení, takže GET nebo HEAD.
429RATE_LIMIT_EXCEEDEDPřed dalším pokusem vyčkejte počet sekund z Retry-After.

Polling

Každých 60 s. Při chybách ostatních endpointů stav dočasně kontrolujte častěji s ohledem na limit požadavků.