Cancels all open orders and trigger orders for the authenticated account across all currencies and instrument kinds. This is a bulk cancellation operation useful for quickly clearing all active orders.
Use the detailed parameter to receive a list of all cancelled orders. The freeze_quotes parameter can be used to freeze quotes instead of cancelling them.
Set include_starbase_orders to true to also cancel the subaccount's Starbase direct-access open orders; the number cancelled is included in the returned cancelled-order count. This flag cannot be combined with detailed, and freeze_quotes is not enforced for Starbase orders.
Note: This operation cannot be undone. All open orders will be permanently cancelled.
Scope: trade:read_write
Query parameters
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
Whether or not to reject incoming quotes for 1 second after cancelling (false by default). Related to private/mass_quote request.
When set to true, the subaccount's Starbase direct-access open orders are also cancelled, and the number cancelled is included in the returned cancelled-order count. Default: false.
Cannot be combined with detailed (doing so returns an invalid_params error). Note that freeze_quotes is not enforced for Starbase orders.
Response
Success response
Example response
{
"result": 7
}