Skip to Content
Spectre Docs
ManualDevelopers
HTTP APISettings

Settings rows

Build your request

Change the values and the command follows. The token is never typed here: the command reads it from the SPECTRE_LOCAL_API_TOKEN environment variable. Run it in your own terminal.

Command
curl 'http://127.0.0.1:48180/v1/settings?category=multiview' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
GET
/settings

Rows as they are stored, with no defaults filled in, ordered by scope, scope_id, category, key. global rows belong to the whole terminal, and order_book rows hold the order-book settings of an instrument or their defaults. writable is false for leverage, trading/leverage_mode, and for service rows of the window.

Authorization

bearerToken settings:read
headerAuthorizationBearer <token>

The Local API token: spt_ and 64 hex characters. Copy it from Settings App → General → Local API. It is accepted only in the Authorization header. The names listed with an operation are the scopes it requires. The token of the terminal carries all of them.

Scope: settings:read

Query Parameters

scope?string

With instrument the scope is always order_book.

Default"global"
Value in"global""order_book"
category?string

Filter by category.

key?string

Filter by key.

connection_id?integer

Rows of this connection. Without it, rows that belong to no connection.

Formatint64
instrument?string

Rows of this pair.

Response Body

The rows.

application/json
  1. response
data*array<>
Example Request
curl 'http://127.0.0.1:48180/v1/settings?category=multiview' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
Example Response
{  "data": [    {      "scope": "global",      "scope_id": "default",      "connection_id": null,      "category": "multiview",      "key": "stack_width_px",      "value": 250,      "writable": true    }  ]}

Open a coin on every exchange POST

Opens the coin the way the Multiview button of the window does. It follows the rows of "Exchange layout", their order-book and chart toggles, and the quote currency of each exchange. Without `target` the tab opens as the "Open" setting of multiview says.

Change settings PATCH

Up to 100 changes in a request. All of them are checked first, then applied in order. If a change fails to apply, the list stops there and the answer names its number: `changes[2]: …`. Changes already applied are not rolled back. A change is addressed like this: - `scope` is `global` by default. With `instrument` it is always `order_book`. - `instrument` addresses the row of a pair. `connection_id` is then chosen by the common rule. - For `order_book` without `instrument`, `connection_id` addresses the default of that connection. Without it the change goes to the global default. - `connection_id` is not accepted for `global`. Some keys are handled in their own way. `appearance/theme` takes an object with any subset of `stack`, `graphic` and `interface`. Each value is a theme name, and `graphic` and `interface` accept only `light` and `dark`. `hotkeys_*` take `{ "code", "modifiers" }` or `null`. A combination taken by another action is refused. `appearance/font_family` and `localization/current_language` are handled in their own way too. The limit is 5 requests a second for all clients together.