Перейти до вмісту
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-стрім

Одне з’єднання для ринкових даних, рахунку, розкладки вікон і налаштувань.