Cancel Order
Normal account covers: Spot / USDT perpetual / Inverse contract
important
- You must specify
orderIdororderLinkIdto cancel the order. - If
orderIdandorderLinkIddo not match, the system will processorderIdfirst. - You can only cancel unfilled or partially filled orders.
HTTP Request
POST /cloud/trade/v3/order/cancel
Request Parameters
| Parameter | Required | Type | Comments |
|---|---|---|---|
| category | true | string | Product type
|
| symbol | true | string | Symbol name |
| orderId | false | string | Order ID. Either orderId or orderLinkId is required |
| orderLinkId | false | string | User customised order ID. Either orderId or orderLinkId is required |
| orderFilter | false | string | Valid for spot only. Order,tpslOrder. If not passed, Order by default |
Response Parameters
| Parameter | Type | Comments |
|---|---|---|
| orderId | string | Order ID |
| orderLinkId | string | User customised order ID |
Request Example
POST /cloud/trade/v3/order/cancel HTTP/1.1
Host: openapi-testnet.zoomex.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672217376681
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json
{
"category": "linear",
"symbol": "BTCUSDT",
"orderLinkId": null,
"orderId":"c6f055d9-7f21-4079-913d-e6523a9cfffa"
}
Response Example
{
"retCode": 0,
"retMsg": "OK",
"result": {
"orderId": "c6f055d9-7f21-4079-913d-e6523a9cfffa",
"orderLinkId": "linear-004"
},
"retExtInfo": {},
"time": 1672217377164
}