exchange.CreateConditionOrder

The exchange.CreateConditionOrder() function is used to create a conditional order. A conditional order is a type of order that is automatically executed when specific trigger conditions are met.

    
    
    
exchange.CreateConditionOrder(symbol, side, amount, condition)

    
    
    
exchange.CreateConditionOrder(symbol, side, amount, condition, ...args)

Examples

• Create a take-profit order (TP): automatically sell when the price rises to the target price.

  • javascript
  • python
  • rust
  • cpp

  
      javascript
      
      
  function main() {
      // Create a take-profit order: when the BTC_USDT price rises to 65000, sell 0.01 BTC at the price of 65000
      var condition = {
          ConditionType: ORDER_CONDITION_TYPE_TP,  // Take-profit order
          TpTriggerPrice: 65000,   // Trigger price
          TpOrderPrice: 65000      // Execution price, can also be set to -1 for a market order
      }
      var id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
      Log("TP order Id:", id)
  }
  

  
      python
      
      
  def main():
      # Create a take-profit order: when the BTC_USDT price rises to 65000, sell 0.01 BTC at the price of 65000
      condition = {
          "ConditionType": ORDER_CONDITION_TYPE_TP,  # Take-profit order
          "TpTriggerPrice": 65000,   # Trigger price
          "TpOrderPrice": 65000      # Execution price, can also be set to -1 for a market order
      }
      id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
      Log("TP order Id:", id)
  

  
      rust
      
      
  fn main() {
      // Create a take-profit order: when the BTC_USDT price rises to 65000, sell 0.01 BTC at the price of 65000
      let condition = OrderCondition {
          ConditionType: ORDER_CONDITION_TYPE_TP,  // Take-profit order
          TpTriggerPrice: 65000.0,   // Trigger price
          TpOrderPrice: 65000.0,     // Execution price, can also be set to -1 for a market order
          ..Default::default()
      };
      let id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, &condition);
      Log!("TP order Id:", id);
  }
  

  
      c++
      
      
  void main() {
      // Create a take-profit order: when the BTC_USDT price rises to 65000, sell 0.01 BTC at the price of 65000
      OrderCondition condition = {.ConditionType = ORDER_CONDITION_TYPE_TP, .TpTriggerPrice = 65000, .TpOrderPrice = 65000};
      auto id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition);
      Log("TP order Id:", id);
  }
  

• Create a stop-loss order (SL): when the price drops to the stop-loss trigger price, automatically sell in the configured manner.

  • javascript
  • python
  • rust
  • cpp

  
      javascript
      
      
  function main() {
      // Create a stop-loss order: when the BTC_USDT price drops to 58000, sell 0.01 BTC at market price
      var condition = {
          ConditionType: ORDER_CONDITION_TYPE_SL,  // Stop-loss order
          SlTriggerPrice: 58000,   // Trigger price
          SlOrderPrice: -1         // -1 indicates a market order
      }
      var id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
      Log("SL order Id:", id)
  }
  

  
      python
      
      
  def main():
      # Create a stop-loss order: when the BTC_USDT price drops to 58000, sell 0.01 BTC at market price
      condition = {
          "ConditionType": ORDER_CONDITION_TYPE_SL,  # Stop-loss order
          "SlTriggerPrice": 58000,   # Trigger price
          "SlOrderPrice": -1         # -1 indicates a market order
      }
      id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
      Log("SL order Id:", id)
  

  
      rust
      
      
  fn main() {
      // Create a stop-loss order: when the BTC_USDT price drops to 58000, sell 0.01 BTC at market price
      let condition = OrderCondition {
          ConditionType: ORDER_CONDITION_TYPE_SL,  // Stop-loss order
          SlTriggerPrice: 58000.0,   // Trigger price
          SlOrderPrice: -1.0,        // -1 indicates a market order
          ..Default::default()
      };
      let id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, &condition);
      Log!("SL order Id:", id);
  }
  

  
      c++
      
      
  void main() {
      // Create a stop-loss order: when the BTC_USDT price drops to 58000, sell 0.01 BTC at market price
      OrderCondition condition = {.ConditionType = ORDER_CONDITION_TYPE_SL, .SlTriggerPrice = 58000, .SlOrderPrice = -1};
      auto id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition);
      Log("SL order Id:", id);
  }
  

• Create an OCO order: set take-profit and stop-loss simultaneously. Once either one is triggered, the other is automatically canceled.

  • javascript
  • python
  • rust
  • cpp

  
      javascript
      
      
  function main() {
      // Create an OCO order: take-profit price 65000, stop-loss price 58000
      var condition = {
          ConditionType: ORDER_CONDITION_TYPE_OCO,  // OCO order
          TpTriggerPrice: 65000,   // Take-profit trigger price
          TpOrderPrice: 65000,     // Take-profit execution price
          SlTriggerPrice: 58000,   // Stop-loss trigger price
          SlOrderPrice: 58000      // Stop-loss execution price
      }
      var id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
      Log("OCO order Id:", id)
  }
  

  
      python
      
      
  def main():
      # Create an OCO order: take-profit price 65000, stop-loss price 58000
      condition = {
          "ConditionType": ORDER_CONDITION_TYPE_OCO,  # OCO order
          "TpTriggerPrice": 65000,   # Take-profit trigger price
          "TpOrderPrice": 65000,     # Take-profit execution price
          "SlTriggerPrice": 58000,   # Stop-loss trigger price
          "SlOrderPrice": 58000      # Stop-loss execution price
      }
      id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition)
      Log("OCO order Id:", id)
  

  
      rust
      
      
  fn main() {
      // Create an OCO order: take-profit price 65000, stop-loss price 58000
      let condition = OrderCondition {
          ConditionType: ORDER_CONDITION_TYPE_OCO,  // OCO order
          TpTriggerPrice: 65000.0,   // Take-profit trigger price
          TpOrderPrice: 65000.0,     // Take-profit execution price
          SlTriggerPrice: 58000.0,   // Stop-loss trigger price
          SlOrderPrice: 58000.0      // Stop-loss execution price
      };
      let id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, &condition);
      Log!("OCO order Id:", id);
  }
  

  
      c++
      
      
  void main() {
      // Create an OCO order: take-profit price 65000, stop-loss price 58000
      OrderCondition condition = {.ConditionType = ORDER_CONDITION_TYPE_OCO, .TpTriggerPrice = 65000, .TpOrderPrice = 65000, .SlTriggerPrice = 58000, .SlOrderPrice = 58000};
      auto id = exchange.CreateConditionOrder("BTC_USDT", "sell", 0.01, condition);
      Log("OCO order Id:", id);
  }
  

• Create a conditional order with an additional parameter (option), used to pass exchange-specific parameters.

  • javascript
  • python
  • rust
  • cpp

  
      javascript
      
      
  function main() {
      // Pass the option parameter in JSON format
      var option = {
          "type": "TRAILING_STOP_MARKET",
          "activatePrice": "300",
          "callbackRate": "0.1"
      }
      var sideWithOption = "buy;" + JSON.stringify(option)
      var condition = {
          ConditionType: ORDER_CONDITION_TYPE_TP,
          TpTriggerPrice: 77,
          TpOrderPrice: 71
      }
      var id = exchange.CreateConditionOrder("SOL_USDT.swap", sideWithOption, 1, condition)
      Log("Condition Order Id:", id)
  
      Sleep(2000)
      Log(exchange.GetConditionOrder(id))
  }
  

  
      python
      
      
  import json
  
  def main():
      # Pass the option parameter in JSON format
      option = {
          "type": "TRAILING_STOP_MARKET",
          "activatePrice": "300",
          "callbackRate": "0.1"
      }
      sideWithOption = "buy;" + json.dumps(option)
      condition = {
          "ConditionType": ORDER_CONDITION_TYPE_TP,
          "TpTriggerPrice": 77,
          "TpOrderPrice": 71
      }
      id = exchange.CreateConditionOrder("SOL_USDT.swap", sideWithOption, 1, condition)
      Log("Condition Order Id:", id)
  
      Sleep(2000)
      Log(exchange.GetConditionOrder(id))
  

  
      rust
      
      
  fn main() {
      // Pass the option parameter in JSON format (Rust has no JSON serialization capability, so a raw string is used directly here to construct it)
      let option = r#"{"type": "TRAILING_STOP_MARKET", "activatePrice": "300", "callbackRate": "0.1"}"#;
      let sideWithOption = format!("buy;{}", option);
      let condition = OrderCondition {
          ConditionType: ORDER_CONDITION_TYPE_TP,
          TpTriggerPrice: 77.0,
          TpOrderPrice: 71.0,
          ..Default::default()
      };
      let id = exchange.CreateConditionOrder("SOL_USDT.swap", &sideWithOption, 1, &condition).unwrap();
      Log!("Condition Order Id:", id);
  
      Sleep(2000);
      Log!(exchange.GetConditionOrder(&id));
  }
  

  
      c++
      
      
  void main() {
      // Pass the option parameter in JSON format
      json option = R"({
          "type": "TRAILING_STOP_MARKET",
          "activatePrice": "300",
          "callbackRate": "0.1"
      })"_json;
      string sideWithOption = "buy;" + option.dump();
      OrderCondition condition = {.ConditionType = ORDER_CONDITION_TYPE_TP, .TpTriggerPrice = 77, .TpOrderPrice = 71};
      auto id = exchange.CreateConditionOrder("SOL_USDT.swap", sideWithOption, 1, condition);
      Log("Condition Order Id:", id);
  
      Sleep(2000);
      Log(exchange.GetConditionOrder(id));
  }
  

Returns

Arguments

See Also

Remarks

Whether conditional orders are supported depends on the specific exchange; some exchanges may not support conditional orders.

A conditional order does not lock up account funds before it is triggered; the order is only actually placed and funds are only committed after it is triggered.

Different exchanges may vary in their level of support for conditional orders and in the specific parameters involved. Please consult the API documentation of the corresponding exchange before use.

Additional parameters (option) can be passed via the side parameter to supply exchange-specific parameters. The additional parameters must be merged into the side parameter, in the format "side;{JSON object}" (recommended) or "side;key=value&key=value" (URL-encoded format). For example: "buy;{\"type\":\"TRAILING_STOP_MARKET\"}".

The option parameters supported vary from exchange to exchange; the specific supported parameters depend on the exchange's API documentation. Common parameters include: order type (type), time in force (timeInForce), activation price (activatePrice), callback rate (callbackRate), and so on.

When using option parameters, you still need to provide the amount and condition parameters. If certain parameters in the exchange API have already been passed via option, these base parameters may be overridden by the corresponding parameters in option; the exact behavior depends on the exchange API's implementation.