exchange.ModifyOrder

The exchange.ModifyOrder() function is used to modify existing regular orders, allowing modification of order price and quantity. Supports modifying other order attributes through additional parameters (depending on exchange API support).

    
    
    
exchange.ModifyOrder(orderId, side, price, amount)

Examples

• Modify the price and quantity of a regular order.

  • javascript
  • python
  • cpp

  
      javascript
      
      
  function main() {
      // Create a limit buy order
      var id = exchange.CreateOrder("SOL_USDT.swap", "buy", 88, 1)
      Log("Original Order ID:", id)
      Sleep(2000)
  
      // Query original order information
      var order = exchange.GetOrder(id)
      Log("Original Order Info:", order)
      Sleep(1000)
  
      // Modify order price and quantity
      var newId = exchange.ModifyOrder(id, "buy", 77, 2)
      Log("Modified Order ID:", newId)
      Sleep(2000)
  
      // Query modified order information
      var newOrder = exchange.GetOrder(newId)
      Log("Modified Order Info:", newOrder)
  
      // Cancel order
      exchange.CancelOrder(newId)
  }
  

  
      python
      
      
  def main():
      # Create a limit buy order
      id = exchange.CreateOrder("SOL_USDT.swap", "buy", 88, 1)
      Log("Original Order ID:", id)
      Sleep(2000)
  
      # Query original order information
      order = exchange.GetOrder(id)
      Log("Original Order Info:", order)
      Sleep(1000)
  
      # Modify order price and quantity
      newId = exchange.ModifyOrder(id, "buy", 77, 2)
      Log("Modified Order ID:", newId)
      Sleep(2000)
  
      # Query modified order information
      newOrder = exchange.GetOrder(newId)
      Log("Modified Order Info:", newOrder)
  
      # Cancel order
      exchange.CancelOrder(newId)
  

  
      c++
      
      
  void main() {
      // Create a limit buy order
      auto id = exchange.CreateOrder("SOL_USDT.swap", "buy", 88, 1);
      Log("Original Order ID:", id);
      Sleep(2000);
  
      // Query original order information
      auto order = exchange.GetOrder(id);
      Log("Original Order Info:", order);
      Sleep(1000);
  
      // Modify order price and quantity
      auto newId = exchange.ModifyOrder(id, "buy", 77, 2);
      Log("Modified Order ID:", newId);
      Sleep(2000);
  
      // Query modified order information
      auto newOrder = exchange.GetOrder(newId);
      Log("Modified Order Info:", newOrder);
  
      // Cancel order
      exchange.CancelOrder(newId);
  }
  

• Use additional parameters (option) to modify the order's price matching mode.

  • javascript
  • python
  • cpp

  
      javascript
      
      
  function main() {
      // Create a limit buy order
      var id = exchange.CreateOrder("SOL_USDT.swap", "buy", 77, 1)
      Log("Original Order ID:", id)
      Sleep(2000)
  
      // Modify order and set price matching mode to QUEUE_20
      // Pass additional parameters (JSON format) through side parameter
      var option = {"priceMatch": "QUEUE_20"}
      var sideWithOption = "buy;" + JSON.stringify(option)
  
      var newId = exchange.ModifyOrder(id, sideWithOption, -1, 2)
      Log("Modified Order ID:", newId)
      Sleep(2000)
  
      // Query modified order information
      var newOrder = exchange.GetOrder(newId)
      Log("Modified Order Info:", newOrder)
  
      // Cancel order
      exchange.CancelOrder(newId)
  }
  

  
      python
      
      
  import json
  
  def main():
      # Create a limit buy order
      id = exchange.CreateOrder("SOL_USDT.swap", "buy", 77, 1)
      Log("Original Order ID:", id)
      Sleep(2000)
  
      # Modify order and set price matching mode to QUEUE_20
      # Pass additional parameters (JSON format) through side parameter
      option = {"priceMatch": "QUEUE_20"}
      sideWithOption = "buy;" + json.dumps(option)
  
      newId = exchange.ModifyOrder(id, sideWithOption, -1, 2)
      Log("Modified Order ID:", newId)
      Sleep(2000)
  
      # Query modified order information
      newOrder = exchange.GetOrder(newId)
      Log("Modified Order Info:", newOrder)
  
      # Cancel order
      exchange.CancelOrder(newId)
  

  
      c++
      
      
  void main() {
      // Create a limit buy order
      auto id = exchange.CreateOrder("SOL_USDT.swap", "buy", 77, 1);
      Log("Original Order ID:", id);
      Sleep(2000);
  
      // Modify order and set price matching mode to QUEUE_20
      // Pass additional parameters (JSON format) through side parameter
      json option = R"({"priceMatch": "QUEUE_20"})"_json;
      string sideWithOption = "buy;" + option.dump();
  
      auto newId = exchange.ModifyOrder(id, sideWithOption, -1, 2);
      Log("Modified Order ID:", newId);
      Sleep(2000);
  
      // Query modified order information
      auto newOrder = exchange.GetOrder(newId);
      Log("Modified Order Info:", newOrder);
  
      // Cancel order
      exchange.CancelOrder(newId);
  }
  

Returns

Arguments

See Also

Remarks

The order ID returned by the exchange.ModifyOrder() function may behave differently depending on the exchange API implementation. Some exchange APIs will update the returned order ID, while others keep it unchanged. It is recommended to use the returned new order ID for subsequent operations.

The exchange.ModifyOrder() function does not validate parameter validity according to exchange interface rules and will submit parameters directly to the exchange API. When invalid parameters are passed (such as price or quantity being -1), the parameters may be ignored by the exchange, and the order maintains its original attributes unchanged.

Supports passing additional parameters (option) through the side parameter to modify other order attributes. Additional parameters need to be merged with the side parameter in the format "side;{JSON object}" (recommended) or "side;key=value" (URL encoding format). For example, to modify price matching mode: "buy;{\"priceMatch\":\"QUEUE_20\"}".

For market order modification of regular orders, you need to check specifically whether the exchange API supports it. Some exchanges do not support market order modification operations.

When modifying orders, other order attributes (such as order type, position mode, account mode, leverage, order validity rules, etc.) usually retain the original order settings. If you need to modify these attributes, you can pass them through additional parameters (option), provided the exchange API supports it.

Some exchange APIs may convert orders to market orders when price parameters are not received (price is -1 or null). For spot market buy orders, note that the order quantity unit may be amount rather than coin quantity.

Support for order modification functionality depends on the specific exchange. Some exchanges may not support order modification functionality or only support modification of certain parameters. Please consult the corresponding exchange's API documentation before use.