Skip to Content
Spectre Docs
ManualDevelopers
HTTP APILeverage and margin

Set the leverage

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 -X POST 'http://127.0.0.1:48180/v1/account/leverage' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "connection_id": 12,
  "instrument": "binance:futures:BTCUSDT",
  "leverage": 20
}'
POST
/account/leverage

Sets a fixed leverage or a leverage mode. Pass exactly one of leverage and mode. The applied value shows in GET after the exchange answers.

Authorization

bearerToken trading:write
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: trading:write

Request Body

application/json
  1. body
connection_id*integer
Formatint64
instrument*string

Instrument address, exchange:market:symbol.

leverage?integer

A fixed leverage. Exactly one of leverage and mode.

Range1 <= value
mode?string

A leverage mode of the terminal. Exactly one of leverage and mode.

Value in"max""smart"

Response Body

The terminal accepted the command. key is null.

application/json
  1. response

The answer of every trading, trigger and leverage command.

accepted*boolean

Accepted by the terminal, not by the exchange.

operation_id*string

The id of the operation in the trading operations log of the terminal. The key of a placed order is t- and this id.

key*|

The key of the placed order, t-…, or of the placed trigger: sl_…, tp_… or stop_…. null for cancels, amendments and leverage.

connection_id*integer
Formatint64
instrument*string
curl -X POST 'http://127.0.0.1:48180/v1/account/leverage' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN" \  -H 'Content-Type: application/json' \  -d '{  "connection_id": 12,  "instrument": "binance:futures:BTCUSDT",  "leverage": 20}'
Example Response
{  "accepted": true,  "operation_id": "173029440000000009",  "key": null,  "connection_id": 12,  "instrument": "binance:futures:BTCUSDT"}

Leverage and margin mode GET

The leverage the terminal has loaded for the instrument. It is loaded when the instrument is chosen in the window or when the leverage is set with `POST`. Before that the answer is `409 not_active`.

Set the margin mode POST

The exchange rejects a change while a position is open. The `accepted` answer does not show that.