Перейти к содержимому
HTTP APIНастройки

Настройки стакана инструмента

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

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

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

Настройки стакана инструмента, как их видит стек этого подключения, по категориям и ключам. Значение берётся из первого места, где оно есть: строка пары на подключении, умолчание подключения, строка пары без подключения, глобальное умолчание. resolved_from называет это место.

Авторизация

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

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

Право: settings:read

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

connection_id*integer

Подключение инструмента.

Форматint64
instrument*string

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

Тело ответа

data[category][key].

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

Категории.

Пример запроса
curl 'http://127.0.0.1:48180/v1/settings/orderbook?connection_id=12&instrument=binance:futures:BTCUSDT' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
Пример ответа
{  "connection_id": 12,  "instrument": "binance:futures:BTCUSDT",  "data": {    "general": {      "auto_scroll": {        "value": false,        "resolved_from": "global",        "writable": true      }    },    "trading": {      "slippage": {        "value": {          "value": "0.1",          "type": "percent"        },        "resolved_from": "instrument",        "writable": true      }    }  }}

Изменить настройки PATCH

До 100 изменений в запросе. Сначала проверяются все, затем они применяются по порядку. Если изменение не применилось, список на нём останавливается, а ответ называет его номер: `changes[2]: …`. Уже применённые изменения не откатываются. Изменение адресуется так: - `scope` по умолчанию равен `global`. С `instrument` область всегда `order_book`. - `instrument` адресует строку пары. `connection_id` тогда выбирается по общему правилу. - Для `order_book` без `instrument` поле `connection_id` адресует умолчание этого подключения. Без него изменение идёт в глобальное умолчание. - `connection_id` не принимается для `global`. Некоторые ключи обрабатываются по-своему. `appearance/theme` принимает объект с любым набором из `stack`, `graphic` и `interface`. Каждое значение — имя темы, а `graphic` и `interface` принимают только `light` и `dark`. `hotkeys_*` принимают `{ "code", "modifiers" }` или `null`. Сочетание, занятое другим действием, отклоняется. `appearance/font_family` и `localization/current_language` тоже обрабатываются по-своему. Лимит — 5 запросов в секунду на всех клиентов вместе.

WebSocket-стрим

Одно соединение для рыночных данных, счёта, раскладки окон и настроек.