Перейти до вмісту
HTTP APIСлужбові

Стан Local API

Зібрати запит

Змінюйте значення — команда змінюється слідом. Токен тут не вводиться: команда бере його зі змінної оточення SPECTRE_LOCAL_API_TOKEN. Запускайте її у своєму командному рядку.

Команда
curl 'http://127.0.0.1:48180/v1/health' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
GET
/health

Авторизація

bearerToken
headerАвторизаціяBearer <token>

Токен Local API: spt_ і 64 шістнадцяткові символи. Скопіюйте його в Settings App → Загальні → Local API. Він приймається лише в заголовку Authorization. Назви, перелічені біля операції, — це права, яких вона потребує. Токен термінала має їх усі.

Тіло відповіді

Статус і лічильники Local API.

application/json
  1. response
status*string

ok, поки API відповідає.

uptime_ms*integer
Форматint64
clients*integer

З’єднання стріму.

streams*integer

Пари, які API обслуговує зараз.

api_only_instruments*integer

Скільки з них відкрито лише для API.

dropped_events*integer

Ринкові події, які не дійшли до жодного клієнта, бо термінал був перевантажений.

Форматint64
dropped_frames*integer

Кадри, відкинуті для клієнтів, які читають надто повільно.

Форматint64
overflow_closes*integer

З’єднання стріму, закриті з кодом 4008.

Форматint64
stream_available*boolean

Чи зібрано термінал із ринковими даними. Без них стрім і ринкові операції відповідають unsupported.

Приклад запиту
curl 'http://127.0.0.1:48180/v1/health' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
Приклад відповіді
{  "status": "ok",  "uptime_ms": 1234,  "clients": 1,  "streams": 3,  "api_only_instruments": 2,  "dropped_events": 0,  "dropped_frames": 0,  "overflow_closes": 0,  "stream_available": true}