Skip to main content

Cancel Order Channel

Description

  • Cancel order
  • Please contact your BD or RM to apply for access permissions
Request
{
"args":[
{
"channel":"cancel-order",
"id":"xxxxx-xxx-xxx-xxxx-xxxxxx",
"instId":"BTCUSDT",
"instType":"USDT-FUTURES",
"params":{
"orderId":"xxxxxxxxxx",
"clientOid":"xxxxx-xxx-xxx-xxxx-xxxxxx"
}
}
],
"op":"trade"
}

Request Parameters

ParameterTypeRequiredDescription
opStringYes"trade"
argsList<Object>YesList of channels to request subscription
> idStringYesUnique Identifier
Length<= 40
("^[0-9A-Za-z_:#\-+\s]*$");
> instTypeStringYesProduct line type USDT-FUTURES
> instIdStringYesProduct ID, e.g. ETHUSDT
> channelStringYesChannel name, cancel-order
> paramsObjectYes
>> orderIdStringNoOrder ID
Either orderId or clientOid is required.If both are present, orderId prevails.
>> clientOidStringNoCustom order ID
Either orderId or clientOid is required.If both are present, orderId prevails.
Fail
{
"event":"trade",
"arg":[
{
"id":"xxxxx-xxx-xxx-xxxx-xxxxxx",
"instType":"USDT-FUTURES",
"channel":"cancel-order",
"instId":"BTCUSDT",
"params":{
"orderId":"xxxxxxxxx",
"clientOid":"xxxxx-xxx-xxx-xxxx-xxxxxx"
}
}
],
"code":0,
"msg":"Success"
}

Response Parameters

ParameterTypeDescription
eventStringEvent
trade
error
argObjectChannel
> idStringUnique Identifier
Length<= 40
("^[0-9A-Za-z_:#\-+\s]*$");
> instTypeStringProduct line type USDT-FUTURES
> instIdStringProduct ID, e.g. ETHUSDT
> channelStringChannel name, cancel-order
> paramsObject
>> orderIdStringOrder ID
Either orderId or clientOid is required.If both are present, orderId prevails.
>> clientOidStringCustom order ID
Either orderId or clientOid is required.If both are present, orderId prevails.
codeStringcode
msgStringmsg

How was your Reading Experience with us?