developers:websocket:orders

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
developers:websocket:orders [2025/03/14 21:42] – chaddevelopers:websocket:orders [2025/03/14 22:10] (current) – chad
Line 1: Line 1:
-==== Order Routing ====+===== Order Routing =====
  
 The WebSocket API provides real-time order routing, allowing clients to submit, revise, and pull orders. [[developers:websocket#message_structure_overview|All order-related operations are sent within a **ClientMessage** envelope and responses are received within a **ServerMessage** envelope.]] The WebSocket API provides real-time order routing, allowing clients to submit, revise, and pull orders. [[developers:websocket#message_structure_overview|All order-related operations are sent within a **ClientMessage** envelope and responses are received within a **ServerMessage** envelope.]]
  
  
-=== Submitting an Order ===+==== Submitting an Order ====
  
 To submit an order, clients send an **OrderSubmit** message. To submit an order, clients send an **OrderSubmit** message.
Line 37: Line 37:
  
  
-=== Revising an Order ===+==== Revising an Order ====
  
 To revise an existing order, clients send an **OrderRevise** message. To revise an existing order, clients send an **OrderRevise** message.
Line 63: Line 63:
  
  
-=== Pulling (Cancelling) an Order ===+==== Pulling (Cancelling) an Order ====
  
 To cancel an order, clients must send an **OrderPull** message with the **order ID**. To cancel an order, clients must send an **OrderPull** message with the **order ID**.
Line 87: Line 87:
  
  
-==== Order Types ====+===== Order Types =====
  
 The WebSocket API supports a variety of order types to accommodate different trading strategies. Below are the supported order types, along with their corresponding **OrderSubmit** messages. The WebSocket API supports a variety of order types to accommodate different trading strategies. Below are the supported order types, along with their corresponding **OrderSubmit** messages.
  
-=== Market Order ===+ 
 + 
 +==== Market Order ====
  
 A Market Order executes immediately at the best available price. A Market Order executes immediately at the best available price.
Line 114: Line 116:
  
  
-=== Limit Order ===+ 
 + 
 +==== Limit Order ====
  
 A Limit Order is submitted with a specific limit price. The order will only execute at the specified price or better. A Limit Order is submitted with a specific limit price. The order will only execute at the specified price or better.
Line 138: Line 142:
  
  
-=== Stop Order ===+ 
 + 
 +==== Stop Order ====
  
 A Stop Market Order becomes a Market Order when the stop price is reached. A Stop Market Order becomes a Market Order when the stop price is reached.
Line 162: Line 168:
  
  
-=== Stop Limit Order ===+ 
 + 
 +==== Stop Limit Order ====
  
 A Stop Limit Order becomes a Limit Order when the stop price is reached. A Stop Limit Order becomes a Limit Order when the stop price is reached.
  
-Example OrderSubmit message:+Example **Stop Limit Order** message:
  
 <code> <code>
Line 187: Line 195:
  
  
-=== Trailing Stop Order ===+ 
 + 
 +==== Trailing Stop Order ====
  
 A Trailing Stop Order moves the stop price automatically based on price movement. A Trailing Stop Order moves the stop price automatically based on price movement.
  
-Example OrderSubmit message:+Example **Trailing Stop Order** message:
  
 +<code>
 OrderSubmit { OrderSubmit {
    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
Line 208: Line 219:
    ]    ]
 } }
 +</code>
  
-=== Fill or Kill (FOK) Order ===+ 
 + 
 + 
 +==== Fill or Kill (FOK) Order ====
  
 A Fill or Kill (FOK) Order must be executed immediately in full or it is canceled. A Fill or Kill (FOK) Order must be executed immediately in full or it is canceled.
  
-Example OrderSubmit message:+Example **Fill or Kill (FOK) Order** message:
  
 +<code>
 OrderSubmit { OrderSubmit {
    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
Line 229: Line 245:
    ]    ]
 } }
 +</code>
  
-=== Immediate or Cancel (IOC) Order ===+ 
 + 
 + 
 +==== Immediate or Cancel (IOC) Order ====
  
 An Immediate or Cancel (IOC) Order executes immediately for the available quantity and cancels the rest. An Immediate or Cancel (IOC) Order executes immediately for the available quantity and cancels the rest.
  
-Example OrderSubmit message:+Example **Immediate or Cancel (IOC) Order** message:
  
 +<code>
 OrderSubmit { OrderSubmit {
    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
Line 250: Line 271:
    ]    ]
 } }
 +</code>
 +
 +
 +
  
-=== Good Till Canceled (GTC) Order ===+==== Good Till Canceled (GTC) Order ====
  
 A Good Till Canceled (GTC) Order remains open until it is filled or explicitly canceled. A Good Till Canceled (GTC) Order remains open until it is filled or explicitly canceled.
  
-Example OrderSubmit message:+Example **Good Till Canceled (GTC) Order** message:
  
 +<code>
 OrderSubmit { OrderSubmit {
    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",    UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
Line 271: Line 297:
    ]    ]
 } }
 +</code>
 +
 +
 +
 +
 +==== Order Cancels Order (OCO) ====
 +
 +An OCO (One Cancels Other) order is a pair of orders submitted together. Both orders are on the same side of the market: one is a Limit Order and the other is a Stop Order. When one fills, the other is automatically canceled. If one order is partially filled, the remaining volume of the other order is adjusted accordingly.
 +
 +OCO orders must be placed for the **same Market and Account**.
 +
 +Example OrderSubmit message for an OCO order:
 +
 +<code>
 +OrderSubmit {
 +   UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
 +   AccountId = "448c9ddd-6a50-4852-85ea-aad3b6d60620",
 +   MarketId = "XCME_C ZC (H25)",
 +   OrderLink = OrderLink.OCO,
 +   Orders = [
 +      {
 +         BuySell = BuySell.Buy,
 +         PriceType = PriceType.Limit,
 +         TimeType = TimeType.Normal,
 +         Volume = 1,
 +         LimitPrice = "2375.00"
 +      },
 +      {
 +         BuySell = BuySell.Buy,
 +         PriceType = PriceType.StopMarket,
 +         TimeType = TimeType.Normal,
 +         Volume = 1,
 +         StopPrice = "2380.00"
 +      }
 +   ]
 +}
 +</code>
 +
 +Both orders are placed at the same time. If the Limit Order is filled, the Stop Order is automatically canceled, and vice versa.
 +
 +
 +
 +
 +==== AutoOCO Order ====
 +
 +An AutoOCO Order is a batch of three orders:
 +  * A Trigger Order that initiates the trade.
 +  * Two OCO Orders (Take Profit and Stop Loss) that execute based on the trigger order's fill price.
 +
 +If the Trigger Order fills, the OCO Orders are submitted. If the OCO Orders begin filling, any remaining volume in the Trigger Order is canceled.
 +
 +Example OrderSubmit message for an AutoOCO order:
 +
 +<code>
 +OrderSubmit {
 +   UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
 +   AccountId = "448c9ddd-6a50-4852-85ea-aad3b6d60620",
 +   MarketId = "XCME_C ZC (H25)",
 +   OrderLink = OrderLink.AutoOCO,
 +   Orders = [
 +      {
 +         BuySell = BuySell.Buy,
 +         PriceType = PriceType.Limit,
 +         TimeType = TimeType.Normal,
 +         Volume = 1,
 +         LimitPrice = "2375.00"
 +      },
 +      {
 +         BuySell = BuySell.Sell,
 +         PriceType = PriceType.Limit,
 +         TimeType = TimeType.Normal,
 +         Volume = 0,
 +         LimitPrice = "2380.00"
 +      },
 +      {
 +         BuySell = BuySell.Sell,
 +         PriceType = PriceType.StopMarket,
 +         TimeType = TimeType.Normal,
 +         Volume = 0,
 +         StopPrice = "2365.00"
 +      }
 +   ]
 +}
 +</code>
 +
 +
 +
 +
 +==== Take Profit and Stop Loss ====
 +
 +Take profit and stop loss orders are a type of OCO order. The first order in the batch is the **Trigger Order**. Once it fills, the **Take Profit** and **Stop Loss** orders are submitted.
 +
 +Example OrderSubmit message for a Take Profit / Stop Loss order:
 +
 +<code>
 +OrderSubmit {
 +   UserId = "efda0709-af12-4b65-8971-5089edb4aaf0",
 +   AccountId = "448c9ddd-6a50-4852-85ea-aad3b6d60620",
 +   MarketId = "XCME_C ZC (H25)",
 +   OrderLink = OrderLink.OCO,
 +   Orders = [
 +      {
 +         BuySell = BuySell.Buy,
 +         PriceType = PriceType.Limit,
 +         TimeType = TimeType.Normal,
 +         Volume = 1,
 +         LimitPrice = "2375.00"
 +      },
 +      {
 +         BuySell = BuySell.Sell,
 +         PriceType = PriceType.Limit,
 +         TimeType = TimeType.Normal,
 +         Volume = 0,
 +         LimitPrice = "2385.00"
 +      },
 +      {
 +         BuySell = BuySell.Sell,
 +         PriceType = PriceType.StopMarket,
 +         TimeType = TimeType.Normal,
 +         Volume = 0,
 +         StopPrice = "2360.00"
 +      }
 +   ]
 +}
 +</code>
 +
 +When the **Trigger Order** executes, the **Take Profit** and **Stop Loss** orders are placed. If the price reaches the take profit level, the stop loss order is canceled, and vice versa.
  
  
  • developers/websocket/orders.1741988527.txt.gz
  • Last modified: 2025/03/14 21:42
  • by chad