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.

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 použití náhradního zdroje, outage při zpoždění přes 5 minut. 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í
degradedomezený provoz
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.
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ů.