Cancel All Orders By Instrument
Method: private/cancel_all_by_instrument
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| instrumentName | string | true | Instrument name |
| type | string | false | Order type - limit, stop, take, trigger_all or all, default - all |
| detailed | boolean | false | When detailed is set to true output format is changed. See description. Default: false |
| freezeQuotes | boolean | false | Whether or not to reject incoming quotes for 1 second after cancelling (false by default). Related to private/mass_quote request. |
| includeCombos | boolean | false | When set to true orders in combo instruments affecting a given position will also be cancelled. Default: false |
Request Example
{
"rid": 41002,
"method": "private/cancel_all_by_instrument",
"params": {
"instrumentName": "BTC-PERPETUAL",
"type": "all"
}
}
Response
Total number of successfully cancelled orders
Response Example
{
"rid": 41002,
"result": 1
}