Перейти к содержимому
Spectre Docs
РуководствоРазработчикам
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}

Версия API, сборка и лимиты GET

Версия API, сборка терминала, права токена, лимиты и топики стрима. Терминал, собранный без рыночных данных, перечисляет в `topics` только `workspace` и `settings`. Рыночные топики и рыночные операции тогда отвечают `unsupported`.

Список подключений GET

Следующая страница