Skip to main content

Cancel Trigger Order

Speed limit is 10 times/s (UID)

Description

Interface for cancelling trigger orders, can be used to cancel by 'productType', 'symbol' and/or trigger ID list.

All orders that fall under that'productType' and 'symbol' will be cancelled.

HTTP Request

  • POST /api/v2/mix/order/cancel-plan-order
Request Example
curl -X POST "https://api.bitget.com/api/v2/mix/order/cancel-plan-order" \
-H "ACCESS-KEY:*******" \
-H "ACCESS-SIGN:*" \
-H "ACCESS-PASSPHRASE:*" \
-H "ACCESS-TIMESTAMP:1659076670000" \
-H "locale:en-US" \
-H "Content-Type: application/json" \
-d '{
"orderIdList": [
{
"orderId": "123",
"clientOid": "321"
},
{
"orderId": "",
"clientOid": "666"
},
{
"orderId": "123",
"clientOid": ""
}
],
"symbol": "ETHUSDT",
"productType": "usdt-futures",
"marginCoin": "USDT"
}'

Request Parameters

ParameterTypeRequiredDescription
orderIdListListNoTrigger order id list.
If it is passed, symbol must not be null and must be aligned with symbol/productType/planType.
>orderIdStringNoTrigger order ID
Either orderId or clientOid is required. If both are entered, orderId prevails.
>clientOidStringNoCustomized trigger order ID
Either orderId or clientOid is required. If both are entered, triggerId prevails.
symbolStringNoTrading pair, e.g. ETHUSDT
productTypeStringYesProduct type
USDT-FUTURES USDT professional futures
COIN-FUTURES Mixed futures
USDC-FUTURES USDC professional futures
SUSDT-FUTURES USDT professional futures demo
SCOIN-FUTURES Mixed futures demo
SUSDC-FUTURES USDC professional futures demo
marginCoinStringNoMargin coin must be capitalized
planTypeStringNoTrigger order type
normal_plan plan order(default)
profit_plan batch profit order
loss_plan batch loss order
pos_profit position profit order
pos_loss position loss order
moving_plan trailing order
Response Example
{
"code": "00000",
"data": {
"successList": [
{
"orderId": "121212121212",
"clientOid": "123"
},
{
"orderId": "123",
"clientOid": ""
}
],
"failureList": [
{
"orderId": "3",
"clientOid": "123",
"errorMsg": "notExistend"
},
{
"orderId": "21221",
"clientOid": "",
"errorMsg": "notExistend"
}
]
},
"msg": "success",
"requestTime": 1627293504612
}

Response Parameters

ParameterTypeDescription
successListList<Object>The collection of successfully cancelled orders.
> orderIdStringOrder ID
> clientOidStringCustomize order ID
failureListList<Object>The collection of unsuccessfully cancelled orders.
> orderIdStringOrder ID
> clientOidStringCustomize order ID
>errorMsgStringFailure reason

How was your Reading Experience with us?