Skip to main content
PUT
TypeScript

Authorizations

Authorization
string
header
required

The Trading API key (trdrs_sk_…), for market data, orders and account state on the accounts its owner holds. Use it server-to-server only, never in a browser. Its scope is named tenant in the API.

Query Parameters

broker
string

The provider the account is at, such as rithmic or paper. Omit it to use your default provider. An unknown value is refused with 400, never replaced with another provider.

account
string

The account number at that provider. It must be one of your own accounts, or the call is refused with 400.

Body

application/json

The leverage to set on one instrument.

instrument
string
required

The instrument.

leverage
number
required

The leverage, greater than 0.

Response

The leverage is set.

The confirmation a write returns when it has nothing else to say.

ok
boolean
required

True when the write succeeded.