Перейти к содержимому
Spectre Docs
РуководствоРазработчикам
HTTP APIРыночные данные

Верхушка стакана

Собрать запрос

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

Команда
curl 'http://127.0.0.1:48180/v1/market/orderbook?instrument=binance:futures:BTCUSDT&depth=20' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
GET
/market/orderbook

Верхние уровни стакана. Уровень — это [price, size]. Если полный стакан не пришёл за 3 с, ответ — 503 unavailable, потому что пустой стакан выглядел бы как пустой рынок.

Авторизация

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

Токен Local API: spt_ и 64 шестнадцатеричных символа. Скопируйте его в Settings App → Общие → Local API. Он принимается только в заголовке Authorization. Имена, перечисленные у операции, — это права, которые ей нужны. У токена терминала есть все.

Право: market:read

Параметры запроса

instrument*string

Адрес инструмента, exchange:market:symbol.

connection_id?integer

Подключение, через которое читать. Без него терминал берёт включённое торговое подключение биржи и рынка, а если такого нет — подключение только для чтения.

Форматint64
depth?integer

Число уровней с каждой стороны.

Диапазон1 <= value <= 200
По умолчанию50

Тело ответа

Верхушка стакана.

application/json
  1. response
instrument*string
connection_id*integer
Форматint64
ts*integer
Форматint64
depth*integer

Запрошенная глубина.

bids*array<array<string>>

От лучшей цены вниз.

asks*array<array<string>>

От лучшей цены вверх.

Пример запроса
curl 'http://127.0.0.1:48180/v1/market/orderbook?instrument=binance:futures:BTCUSDT&depth=20' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
Пример ответа
{  "instrument": "binance:futures:BTCUSDT",  "connection_id": 12,  "ts": 1730294400123,  "depth": 20,  "bids": [    [      "67000.1",      "1.25"    ]  ],  "asks": [    [      "67000.2",      "0.40"    ]  ]}

Снимок рынка GET

Последнее, что терминал знает о паре. Поле равно `null`, пока его данные не пришли. `best_bid` и `best_ask` — это `[price, size]` из стакана.

Кластеры объёма GET

До десяти последних бакетов кластеров, от старых к новым. Интервал — тот, что выбран для инструмента в терминале, по умолчанию `5m`. Для инструмента, который не открыт в терминале, первый вызов запускает расчёт и ждёт историю до 3 с.