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, and keep it on your server. Its scope is named trading in the API.

Query Parameters

provider
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 margin mode to set on one instrument, or on the account where the provider holds one mode for the whole account.

instrument
string
required

The instrument.

marginMode
enum<string>
required

The margin mode to set.

Available options:
cross,
isolated

Response

The margin mode is set.

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

ok
boolean
required

True when the write succeeded.