Skip to main content
POST
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

Which working orders to cancel.

instrument
string

The instrument whose orders to cancel. Omit it to cancel on every instrument.

Response

Every order is cancelled. The response gives how many.

How many working orders were cancelled.

cancelled
integer
required

How many orders were cancelled.

total
integer
required

How many working orders there were to cancel.