Перейти до вмісту
Spectre Docs
ПосібникРозробникам
HTTP APIНалаштування

Змінити налаштування

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

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

Команда
curl -X PATCH 'http://127.0.0.1:48180/v1/settings' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "changes": [
    {
      "category": "multiview",
      "key": "stack_width_px",
      "value": 300
    },
    {
      "instrument": "binance:futures:XRPUSDT",
      "connection_id": 25,
      "category": "trading",
      "key": "slippage",
      "value": {
        "value": "0.1",
        "type": "percent"
      }
    },
    {
      "scope": "order_book",
      "connection_id": 25,
      "category": "general",
      "key": "auto_scroll",
      "value": true
    },
    {
      "category": "appearance",
      "key": "theme",
      "value": {
        "stack": "dark"
      }
    },
    {
      "category": "hotkeys_orderbook",
      "key": "close_position",
      "value": {
        "code": "KeyX",
        "modifiers": []
      }
    }
  ]
}'
PATCH
/settings

До 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 запитів на секунду на всіх клієнтів разом.

Авторизація

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

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

Право: settings:write

Тіло запиту

application/json
  1. body
changes*array<>
Елементи1 <= items <= 100

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

Скільки змін застосовано.

application/json
  1. response
applied*integer

Кількість застосованих змін.

Приклад запиту
curl -X PATCH 'http://127.0.0.1:48180/v1/settings' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN" \  -H 'Content-Type: application/json' \  -d '{  "changes": [    {      "category": "multiview",      "key": "stack_width_px",      "value": 300    },    {      "instrument": "binance:futures:XRPUSDT",      "connection_id": 25,      "category": "trading",      "key": "slippage",      "value": {        "value": "0.1",        "type": "percent"      }    },    {      "scope": "order_book",      "connection_id": 25,      "category": "general",      "key": "auto_scroll",      "value": true    },    {      "category": "appearance",      "key": "theme",      "value": {        "stack": "dark"      }    },    {      "category": "hotkeys_orderbook",      "key": "close_position",      "value": {        "code": "KeyX",        "modifiers": []      }    }  ]}'
Приклад відповіді
{  "applied": 5}

Рядки налаштувань GET

Рядки так, як вони зберігаються, без підставлених типових значень, впорядковані за `scope`, `scope_id`, `category`, `key`. Рядки `global` належать усьому терміналу, а рядки `order_book` містять налаштування стакана інструмента або їхні типові значення. `writable` дорівнює `false` для плеча, `trading/leverage_mode` і службових рядків вікна.

Налаштування стакана для інструмента GET

Налаштування стакана інструмента такими, як їх бачить стек цього підключення, за категорією і ключем. Значення береться з першого місця, де воно є: рядок пари на підключенні, типове значення підключення, рядок пари без підключення, глобальне типове значення. `resolved_from` називає це місце.