Skip to main content

Cancel All Orders

Cancel all open orders

Normal account covers: Spot / USDT perpetual / Inverse contract

info
  • Support cancel orders by symbol/baseCoin/settleCoin. If you pass multiple of these params, the system will process one of param, which priority is symbol > baseCoin > settleCoin.
  • NOTE: category for linear or inverse, you must specify one of those three params.
  • NOTE: category=spot, you can cancel all spot open orders (normal order by default) without passing other params.

HTTP Request

POST /cloud/trade/v3/order/cancel-all

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct type
  • Normal account: spot, linear, inverse
symbolfalsestringSymbol name. linear & inverse: Required if not passing baseCoin or settleCoin
baseCoinfalsestringBase coin
  • linear & inverse: If cancel all by baseCoin, it will cancel all linear & inverse orders. Required if not passing symbol or settleCoin
settleCoinfalsestringSettle coin
  • linear & inverse: Required if not passing symbol or baseCoin
  • Does not support spot
orderFilterfalsestring
  • category=spot, you can pass Order, tpslOrder. If not passed, Order by default
  • category=linear or inverse, you can pass Order, StopOrder. If not passed, all kinds of orders will be cancelled, like active order, conditional order, TP/SL order and trailing stop order
stopOrderTypefalsestringStop order type Stop
  • Only used for category=linear or inverse and orderFilter=StopOrder,you can cancel conditional orders except TP/SL order and Trailing stop orders with this param

  • Response Parameters

    ParameterTypeComments
    listarrayObject
    > orderIdstringOrder ID
    > orderLinkIdstringUser customised order ID
    successstring"1": success, "0": fail

    Request Example

    POST /cloud/trade/v3/order/cancel-all HTTP/1.1
    Host: openapi-testnet.zoomex.com
    X-BAPI-SIGN: XXXXX
    X-BAPI-API-KEY: XXXXX
    X-BAPI-TIMESTAMP: 1672219779140
    X-BAPI-RECV-WINDOW: 5000
    Content-Type: application/json

    {
    "category": "linear",
    "symbol": null,
    "settleCoin": "USDT"
    }

    Response Example

    {
    "retCode": 0,
    "retMsg": "OK",
    "result": {
    "list": [
    {
    "orderId": "f6a73e1f-39b5-4dee-af21-1460b2e3b27c",
    "orderLinkId": "a001"
    }
    ]
    },
    "retExtInfo": {},
    "time": 1672219780463
    }