private/cancel_all_by_instrument

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

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/cancel_all_by_instrument \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 4122,
  "method": "private/cancel_all_by_instrument",
  "params": {
    "instrument_name": "ETH-22FEB19-120-P",
    "type": "all"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 47,
  "result": 4
}

Query Parameters

instrument_name · string · required

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

type · enum<string>

Order type - limit, stop, take, trigger_all or all, default - all Order type: "all", "limit", "stop", "take", "trailing_stop", "trailing_take"

Available options: all, limit, trigger_all, stop, take, trailing_stop

detailed · boolean

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_combos · boolean

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

freeze_quotes · boolean

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

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · number · required

Total number of successfully cancelled orders

Example:

7

id · integer

The id that was sent in the request