Rate Limit: 2 request per 1 second
Tip:
You can cancel order by websocket after login.
Request
{
"id": "1",
"action": "CANCEL_MULTI_ORDER",
"args": [{
'clientOrderId': '',
'orderId': '2068661347173185'
},
{
'clientOrderId': 'test2',
'orderId': ''
},
]
}
| Field name | Type | Necessary | Remarks |
|---|---|---|---|
| id | String | N | client request id |
| action | String | Y | CANCEL_MULTI_ORDER |
| args | Object | Y | request params |
| > orderId | String | N | Order ID |
| > clientOrderId | String | N | Customer defined order ID ,only support letters(a-z) and numbers(0-9) |
Tip:
- Either orderId or clientOrderId must be sent. If both orderId and clientOrderId are provided, orderId takes precedence,note that you can only cancel orders in the NEW/OPEN/PARTIALLY_FILLED status,otherwise even if the api request successful, it does not mean that the order has been cancelled.
- Max order cancellation limit: 10 per request.
- Results are returned in the same sequence as the provided array.
Response
Success example:
{
'id': '1',
'event': 'CANCEL_MULTI_ORDER',
'code': 200000,
'msg': 'Success',
'data': [{
'msg': 'Success',
'orderId': '2068661347173185',
'clientOrderId': '',
'code': '200000'
},
{
'msg': 'Success',
'orderId': '2068662764926785',
'clientOrderId': 'test2',
'code': '200000'
}]
}
Fail example:
{
"id": "",
"event": "CANCEL_MULTI_ORDER",
"code": 601011,
"msg": "Not support this operation"
}
| Field name | Type | Remarks |
|---|---|---|
| id | String | client request id |
| event | String | Event |
| code | String | Code |
| msg | String | Msg |
| data | Object | response data |
| > orderId | String | Order ID |
| > clientOrderId | String | Customer-defined order ID |
