Syntax

exchange.CancelConditionOrder() function is used to cancel a conditional order. The format of the conditional order Id is similar to that of a regular order Id, consisting of the exchange symbol code and the exchange's original conditional order Id, separated by an English comma.

When calling the exchange.CancelConditionOrder() function to cancel a conditional order, the conditionOrderId parameter passed in is consistent with the Id attribute of the conditional order structure.


    
    
    
exchange.CancelConditionOrder(conditionOrderId)


    
    
    
exchange.CancelConditionOrder(conditionOrderId, ...args)

Examples

Cancel a conditional order.


    javascript
    
    
function main(){
    // Create a stop-loss conditional order
    var condition = {
        ConditionType: ORDER_CONDITION_TYPE_SL,
        SlTriggerPrice: 58000,
        SlOrderPrice: -1  // Market order
    }
    var id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
    Sleep(1000)
    exchange.CancelConditionOrder(id)
}


    python
    
    
def main():
    # Create a stop-loss conditional order
    condition = {
        "ConditionType": ORDER_CONDITION_TYPE_SL,
        "SlTriggerPrice": 58000,
        "SlOrderPrice": -1  # Market order
    }
    id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
    Sleep(1000)
    exchange.CancelConditionOrder(id)


    rust
    
    
fn main() {
    // Create a stop-loss conditional order
    let condition = OrderCondition {
        ConditionType: ORDER_CONDITION_TYPE_SL,
        SlTriggerPrice: 58000.0,
        SlOrderPrice: -1.0,  // Market order
        ..Default::default()
    };
    let id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, &condition).unwrap();
    Sleep(1000);
    let _ = exchange.CancelConditionOrder(&id);
}


    c++
    
    
void main() {
    // Create a stop-loss conditional order
    OrderCondition condition = {.ConditionType = ORDER_CONDITION_TYPE_SL, .SlTriggerPrice = 58000, .SlOrderPrice = -1};
    auto id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition);
    Sleep(1000);
    exchange.CancelConditionOrder(id);
}

Batch cancel condition orders, with condition order information output.


    javascript
    
    
function main() {
    // Create several condition orders
    var condition1 = {
        ConditionType: ORDER_CONDITION_TYPE_TP,
        TpTriggerPrice: 65000,
        TpOrderPrice: 65000
    }
    exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition1)

    var condition2 = {
        ConditionType: ORDER_CONDITION_TYPE_SL,
        SlTriggerPrice: 58000,
        SlOrderPrice: 58000
    }
    exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition2)
    Sleep(1000)

    var orders = exchange.GetConditionOrders()
    for (var i = 0 ; i < orders.length ; i++) {
        exchange.CancelConditionOrder(orders[i].Id, "Canceled condition order:", orders[i])
        Sleep(500)
    }
}


    python
    
    
def main():
    # Create several condition orders
    condition1 = {
        "ConditionType": ORDER_CONDITION_TYPE_TP,
        "TpTriggerPrice": 65000,
        "TpOrderPrice": 65000
    }
    exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition1)

    condition2 = {
        "ConditionType": ORDER_CONDITION_TYPE_SL,
        "SlTriggerPrice": 58000,
        "SlOrderPrice": 58000
    }
    exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition2)
    Sleep(1000)

    orders = exchange.GetConditionOrders()
    for i in range(len(orders)):
        exchange.CancelConditionOrder(orders[i]["Id"], "Canceled condition order:", orders[i])
        Sleep(500)


    rust
    
    
fn main() {
    // Create several condition orders
    let condition1 = OrderCondition {
        ConditionType: ORDER_CONDITION_TYPE_TP,
        TpTriggerPrice: 65000.0,
        TpOrderPrice: 65000.0,
        ..Default::default()
    };
    let _ = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, &condition1);

    let condition2 = OrderCondition {
        ConditionType: ORDER_CONDITION_TYPE_SL,
        SlTriggerPrice: 58000.0,
        SlOrderPrice: 58000.0,
        ..Default::default()
    };
    let _ = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, &condition2);
    Sleep(1000);

    let orders = exchange.GetConditionOrders(None).unwrap();
    for i in 0..orders.len() {
        // In Rust, CancelConditionOrder does not support extended parameters; output the accompanying information with Log
        let _ = exchange.CancelConditionOrder(&orders[i].Id);
        Log!("Canceled condition order:", orders[i]);
        Sleep(500);
    }
}


    c++
    
    
void main() {
    // Create several condition orders
    OrderCondition condition1 = {.ConditionType = ORDER_CONDITION_TYPE_TP, .TpTriggerPrice = 65000, .TpOrderPrice = 65000};
    exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition1);

    OrderCondition condition2 = {.ConditionType = ORDER_CONDITION_TYPE_SL, .SlTriggerPrice = 58000, .SlOrderPrice = 58000};
    exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition2);
    Sleep(1000);

    auto orders = exchange.GetConditionOrders();
    for (int i = 0 ; i < orders.size() ; i++) {
        exchange.CancelConditionOrder(orders[i].Id, "Canceled condition order:", orders[i]);
        Sleep(500);
    }
}

Returns

Type	Description
bool	The `exchange.CancelConditionOrder()` function returns a truthy value (e.g. `true`) to indicate that the request to cancel the conditional order was sent successfully, and returns a falsy value (e.g. `false`) to indicate that the request to cancel the conditional order failed to send.

Arguments

Name	Type	Required	Description
conditionOrderId	string	Yes	The `conditionOrderId` parameter is used to specify the conditional order to be canceled.
arg	string / number / bool / object / array / any (any type supported by the platform)	No	An extended parameter used to output additional information to the log of this canceled conditional order. Multiple `arg` parameters can be passed in.