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 · ServiceStatusResponseEndpoint 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.
| Pole | Popis |
|---|---|
| statusstring | Během údržby maintenance, jinak nejhorší stav API a jeho komponent. Hodnoty: operational, degraded, outage, maintenance. |
| apistring | Stav samotného API: operational, během údržby maintenance. Hodnoty: operational, degraded, outage, maintenance. |
| componentsServiceComponentsResponse | Stavy jednotlivých komponent API. |
| components.tickerstring | Stav 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 null | Oznámená údržba, jinak null; pole je vždy přítomné. |
| maintenance.fromstring | Začátek údržby v ISO 8601, UTC. |
| maintenance.fromMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| maintenance.tostring | Předpokládaný konec údržby v ISO 8601, UTC. |
| maintenance.toMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| maintenance.descriptionstring | Popis údržby v angličtině, jak jej vrací API. |
| lastUpdatedAtnull nebo string | Poslední 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 integer | Stejný okamžik jako Unix timestamp v milisekundách, případně null. |
| serverTimestring | Aktuá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í.
| PublicServiceStatus | Význam |
|---|---|
operational | plně funkční |
degraded | omezený provoz |
outage | výpadek nebo příliš stará data |
maintenance | plánovaná údržba |
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 | Doplňte hlavičku X-COINERO-APIKEY. Ověřte hodnotu a stav klíče i aktivitu účtu. |
| 429 | RATE_LIMIT_EXCEEDED | Př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ů.