exchange.CancelConditionOrder

The exchange.CancelConditionOrder() function is used to cancel a conditional order. The conditional order ID format is similar to regular order IDs, consisting of the exchange instrument code and the exchange's original conditional order ID, separated by a comma.

When calling the exchange.CancelConditionOrder() function to cancel a conditional order, the conditionOrderId parameter passed should match the Id property of the conditional order structure.

    
    
    
exchange.CancelConditionOrder(conditionOrderId)

    
    
    
exchange.CancelConditionOrder(conditionOrderId, ...args)

Examples

• Cancel a conditional order.

  • javascript
  • python
  • cpp

  
      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)
  

  
      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 and output condition order information.

  • javascript
  • python
  • cpp

  
      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)
  

  
      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

Arguments

See Also

Remarks

The return value of the exchange.CancelConditionOrder() function only indicates whether the request was sent successfully or failed. To determine whether the exchange has actually canceled the conditional order, you can call the exchange.GetConditionOrders() function to confirm.

Only untriggered conditional orders can be canceled. Conditional orders that have been triggered and converted to regular orders cannot be canceled through this function.