v2

OpenAPI 3.0.02026-07-311824171.4 MB
Trading
Matching Engine
Private

Cancels all open orders for a specific instrument. This is useful for quickly clearing all orders for a single instrument.

Orders can be optionally filtered by order type (limit, market, stop, etc.). Use the detailed parameter to receive a list of all cancelled orders. The include_combos parameter can be used to include combo orders in the cancellation.

Scope: trade:read_write

Try in API console

get/private/cancel_all_by_instrument

Query parameters

instrument_namestring required

Unique instrument identifier

Example:BTC-PERPETUAL

Instrument name

type'all' | 'limit' | 'trigger_all' | 'stop' | 'take' | 'trailing_stop'

Order type: "all", "limit", "stop", "take", "trailing_stop", "trailing_take"

Order type - limit, stop, take, trigger_all or all, default - all

detailedboolean

When detailed is set to true, the output format is changed to include a list of all cancelled orders.

📖 Related Article: Detailed Response for Cancel Methods

Default: false

include_combosboolean

When set to true orders in combo instruments affecting a given position will also be cancelled. Default: false

freeze_quotesboolean

Whether or not to reject incoming quotes for 1 second after cancelling (false by default). Related to private/mass_quote request.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

resultnumber required

Total number of successfully cancelled orders

Example response

{
  "result": 7
}