Order Types

Introduction
Copy Location

This page is used to document all available order types available through the Interactive Brokers API interfaces. The values documented showcase the minimum values needed to create the order. Additional parameters can be used or combined in some cases.

You can find the available fields or parameters for orders in their respective interfaces:

Notes & Limitations
Copy Location

While the Interactive Brokers support team can help assist with required parameters for the API, they can not comment on best orders to use, financial or trading advice, or any further information aside from API logic.
It is important to test the order type idea manually in TWS before writing the API execution tactic because some execution ideas (e.g. applying STP LMT on Iceberg / applying Bracket Order with IBALGO) may not supported by TWS. As a result, they will not be supported by API too.
Paper Trading Accounts are based on a simulated environment, and as a result, order execution behavior is not indicative of real world trading conditions. The paper accounts should be used exclusively for understanding how tools function.
It is important to test the order type idea manually in TWS before writing the API execution tactic because some execution ideas (e.g. applying STP LMT on Iceberg / applying Bracket Order with IBALGO) may not supported by TWS. As a result, they will not be supported by API too.
Interacive Brokers APIs do not support fractional or cash quantity trading with exception to Cryptocurrencies and Forex trading.

Cryptocurrency Trading
Copy Location

Because Cryptocurrencies at Interactive Brokers are managed through external groups like ZEROHASH and PAXOS, the available order types and behaviors are slightly different from average. The lists below indicate what is available for BUY and SELL orders when using Cryptocurrencies.

Please be aware that no other order types are available for Crypto orders.

BUY

Order Types

LMT Order Using “quantity” or “totalQuantity” values.
MKT Orders using “cashQty” value.

Time in Force

LMT Orders support “DAY”, “GTC”, “IOC”

The TWS API Also Supports the “Minutes” time in force.

MKT Orders only support “IOC”.

SELL

Order Types

LMT Order Using “quantity” or “totalQuantity values.
MKT orders using “quantity” or “totalQuantity” values.

Time in Force

LMT Orders support “DAY”, “GTC”, “IOC”

The TWS API Also Supports the “Minutes” time in force.

MKT Orders only support “IOC”.

Order Efficiency Ratio
Copy Location

While Interactive Brokers’ API offerings do maintain their own pacing limitations, Interactive Brokers as a whole maintains an order pacing limitation. This is known as the Order Efficiency Ratio. While this does not typically effect regular traders, automated trading systems may be impacted. This is because OER does not necessarily impact a lower volume of trades, but will effect those who submit thousands of orders without regular execution.

More information about measuring and understanding the order efficiency ratio can be found in our Order Management Overview article.

Order Type by API
Copy Location

It is important to note that while this page does document both our TWS API and CPAPI, not all order types are available in both platforms.

As such, please keep in mind:

Orders labeled in Python, Java, C++, C#, and Visual Basic are for use in the TWS API
Orders labeled in CURL are for use in the Client Portal API

Basic Orders
Copy Location

This section will explore all available orders through Interactive Brokers that can be accomplished in a single standard request structure. This includes typical behaviors such as Market, Limit, and Stop orders.

Auction Orders
Copy Location

Auction
Copy Location

An Auction order is entered into the electronic trading system during the pre-market opening period for execution at the Calculated Opening Price (COP). If your order is not filled on the open, the order is re-submitted as a limit order with the limit price set to the COP or the best bid/ask after the market opens.

Products: FUT, STK

More on Supported exchanges

order = Order()
order.action = action
order.tif = "AUC"
order.orderType = "MTL"
order.totalQuantity = quantity
order.lmtPrice = price

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.tif("AUC");
order.orderType("MTL");
order.totalQuantity(quantity);
order.lmtPrice(price);

Order order;
order.action = action;
order.tif = "AUC";
order.orderType = "MTL";
order.totalQuantity = quantity;
order.lmtPrice = price;

Order order = new Order();
order.Action = action;
order.Tif = "AUC";
order.OrderType = "MTL";
order.TotalQuantity = quantity;
order.LmtPrice = price;

Dim order As Order = New Order
order.Action = action
order.Tif = "AUC"
order.OrderType = "MTL"
order.TotalQuantity = quantity
order.LmtPrice = price

Auction Limit
Copy Location

Products: OPT (BOX only)

Auction Pegged to Stock
Copy Location

For option orders routed to the Boston Options Exchange (BOX) you may elect to participate in the BOX’s price improvement auction in pennies. All BOX-directed price improvement orders are immediately sent from Interactive Brokers to the BOX order book, and when the terms allow, IB will evaluate it for inclusion in a price improvement auction based on price and volume priority. In the auction, your order will have priority over broker-dealer price improvement orders at the same price. An Auction Pegged to Stock order adjusts the order price by the product of a signed delta (which is entered as an absolute and assumed to be positive for calls, negative for puts) and the change of the option’s underlying stock price. A buy or sell call order price is determined by adding the delta times a change in an underlying stock price change to a specified starting price for the call. To determine the change in price, a stock reference price (NBBO midpoint at the time of the order is assumed if no reference price is entered) is subtracted from the current NBBO midpoint. A stock range may also be entered that cancels an order when reached. The delta times the change in stock price will be rounded to the nearest penny in favor of the order and will be used as your auction improvement amount.

Products: OPT (BOX only)

Auction Relative
Copy Location

Stock-Option contracts directly routed to BOX will support a Price Improvement Auction Orders compared to standard SMART routing. This order will necessitate a standard Relative / Pegged-To-Primary order with the contract being directly routed to “BOX” rather than “SMART” or another exchange.

Products: OPT (BOX only)

Block
Copy Location

The Block attribute is used for large volume option orders on ISE that consist of at least 50 contracts. To execute large-volume orders over time without moving the market, use the Accumulate/Distribute algorithm.

Products: OPT

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "LMT"
order.totalQuantity = quantity#Large volumes!
order.lmtPrice = price
order.blockOrder = True

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("LMT");
order.totalQuantity(quantity);//Large volumes!
order.lmtPrice(price);
order.blockOrder(true);

Order order;
order.action = action;
order.orderType = "LMT";
order.totalQuantity = quantity;
order.lmtPrice = price;
order.blockOrder = true;

Order order = new Order();
order.Action = action;
order.OrderType = "LMT";
order.TotalQuantity = quantity;//Large volumes!
order.LmtPrice = price;
order.BlockOrder = true;

Dim order As Order = New Order
order.Action = action
order.OrderType = "LMT"
order.TotalQuantity = quantity ' Large volumes!
order.LmtPrice = price
order.BlockOrder = True

Box Top
Copy Location

A Box Top order executes as a market order at the current best price. If the order is only partially filled, the remainder is submitted as a limit order with the limit price equal to the price at which the filled portion of the order executed.

Products: OPT (BOX only)

Combo Limit
Copy Location

Create combination orders that include options, stock and futures legs (stock legs can be included if the order is routed through SmartRouting). Although a combination/spread order is constructed of separate legs, it is executed as a single transaction if it is routed directly to an exchange. For combination orders that are SmartRouted, each leg may be executed separately to ensure best execution.

Products: OPT, STK, FUT

order.action = action
order.orderType = "LMT"
order.totalQuantity = quantity
order.lmtPrice = limitPrice
if nonGuaranteed:
	order.smartComboRoutingParams = []
	order.smartComboRoutingParams.append(TagValue("NonGuaranteed", "1"))

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "LMT",
      "price": price,
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("LMT");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
if (nonGuaranteed)
{
	order.smartComboRoutingParams().add(new TagValue("NonGuaranteed", "1"));
}

Order order;
order.action = action;
order.orderType = "LMT";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;
if(nonGuaranteed){
	TagValueSPtr tag1(new TagValue("NonGuaranteed", "1"));
	order.smartComboRoutingParams.reset(new TagValueList());
	order.smartComboRoutingParams->push_back(tag1);
}

Order order = new Order();
order.Action = action;
order.OrderType = "LMT";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;
if (nonGuaranteed)
{
	order.SmartComboRoutingParams = new List<TagValue>();
	order.SmartComboRoutingParams.Add(new TagValue("NonGuaranteed", "1"));
}

Dim order As Order = New Order
order.Action = action
order.OrderType = "LMT"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice
If (nonGuaranteed) Then
	order.SmartComboRoutingParams = New List(Of TagValue)
	order.SmartComboRoutingParams.Add(New TagValue("NonGuaranteed", "1"))
End If

Combo Limit with Price per Leg
Copy Location

Products: OPT, STK, FUT

order = Order()
order.action = action
order.orderType = "LMT"
order.totalQuantity = quantity
order.orderComboLegs = []

for price in legPrices:
	comboLeg = OrderComboLeg()
	comboLeg.price = price
	order.orderComboLegs.append(comboLeg)
   
if nonGuaranteed:
	order.smartComboRoutingParams = []
	order.smartComboRoutingParams.append(TagValue("NonGuaranteed", "1"))

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("LMT");
order.totalQuantity(quantity);
order.orderComboLegs(new ArrayList<>());

for(double price : legPrices) {
	OrderComboLeg comboLeg = new OrderComboLeg();
	comboLeg.price(5.0);
	order.orderComboLegs().add(comboLeg);
}

if (nonGuaranteed)
{
	order.smartComboRoutingParams().add(new TagValue("NonGuaranteed", "1"));
}

Order order;
order.action = action;
order.orderType = "LMT";
order.totalQuantity = quantity;
order.orderComboLegs.reset(new Order::OrderComboLegList());
for(unsigned int i = 0; i < legprices.size(); i++){
	OrderComboLegSPtr comboLeg(new OrderComboLeg());
	comboLeg->price = legprices[i];
	order.orderComboLegs->push_back(comboLeg);
}
if(nonGuaranteed){
	TagValueSPtr tag1(new TagValue("NonGuaranteed", "1"));
	order.smartComboRoutingParams.reset(new TagValueList());
	order.smartComboRoutingParams->push_back(tag1);
}

Order order = new Order();
order.Action = action;
order.OrderType = "LMT";
order.TotalQuantity = quantity;
order.OrderComboLegs = new List<OrderComboLeg>();
foreach(double price in legPrices)
{
	OrderComboLeg comboLeg = new OrderComboLeg();
	comboLeg.Price = 5.0;
	order.OrderComboLegs.Add(comboLeg);
}           
if (nonGuaranteed)
{
	order.SmartComboRoutingParams = new List<TagValue>();
	order.SmartComboRoutingParams.Add(new TagValue("NonGuaranteed", "1"));
}

Dim order As Order = New Order
order.Action = action
order.OrderType = "LMT"
order.TotalQuantity = quantity
order.OrderComboLegs = New List(Of OrderComboLeg)
For Each price As Double In legPrices
	Dim ComboLeg As OrderComboLeg = New OrderComboLeg
	ComboLeg.Price = 5.0
	order.OrderComboLegs.Add(ComboLeg)
Next price
If (nonGuaranteed) Then
	order.SmartComboRoutingParams = New List(Of TagValue)
	order.SmartComboRoutingParams.Add(New TagValue("NonGuaranteed", "1"))
End If

Combo Market
Copy Location

Products: OPT, STK, FUT

order = Order()
order.action = action
order.orderType = "MKT"
order.totalQuantity = quantity
if nonGuaranteed:
	order.smartComboRoutingParams = []
	order.smartComboRoutingParams.append(TagValue("NonGuaranteed", "1"))

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conidex": "{spread_conid};;;{leg_conid1}/{ratio},{leg_conid2}/{ratio}",
      "orderType": "orderType",
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

See the Client Portal Combo / Spread Orders section

Order order = new Order();
order.action(action);
order.orderType("MKT");
order.totalQuantity(quantity);
if (nonGuaranteed)
{
	order.smartComboRoutingParams().add(new TagValue("NonGuaranteed", "1"));
}

Order order;
order.action = action;
order.orderType = "MKT";
order.totalQuantity = quantity;
if(nonGuaranteed){
	TagValueSPtr tag1(new TagValue("NonGuaranteed", "1"));
	order.smartComboRoutingParams.reset(new TagValueList());
	order.smartComboRoutingParams->push_back(tag1);
}

Order order = new Order();
order.Action = action;
order.OrderType = "MKT";
order.TotalQuantity = quantity;
if (nonGuaranteed)
{
	order.SmartComboRoutingParams = new List<TagValue>();
	order.SmartComboRoutingParams.Add(new TagValue("NonGuaranteed", "1"));
}

Dim order As Order = New Order
order.Action = action
order.OrderType = "MKT"
order.TotalQuantity = quantity
If (nonGuaranteed) Then
	order.SmartComboRoutingParams = New List(Of TagValue)
	order.SmartComboRoutingParams.Add(New TagValue("NonGuaranteed", "1"))
End If

Discretionary
Copy Location

An Discretionary order is a limit order submitted with a hidden, specified ‘discretionary’ amount off the limit price which may be used to increase the price range over which the limit order is eligible to execute. The market sees only the limit price.

Products: STK

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "LMT"
order.totalQuantity = quantity
order.lmtPrice = price
order.discretionaryAmt = discretionaryAmount

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("LMT");
order.totalQuantity(quantity);
order.lmtPrice(price);
order.discretionaryAmt(discretionaryAmt);

Order order;
order.action = action;
order.orderType = "LMT";
order.totalQuantity = quantity;
order.lmtPrice = price;
order.discretionaryAmt = discretionaryAmount;

Order order = new Order();
order.Action = action;
order.OrderType = "LMT";
order.TotalQuantity = quantity;
order.LmtPrice = price;
order.DiscretionaryAmt = discretionaryAmount;

Dim order As Order = New Order
order.Action = action
order.OrderType = "LMT"
order.TotalQuantity = quantity
order.LmtPrice = price
order.DiscretionaryAmt = discretionaryAmount

Forex Cash Quantity Order
Copy Location

Forex orders can be placed in denomination of second currency in pair using cashQty field.

Products: CASH

Limit Orders
Copy Location

Limit Order
Copy Location

A Limit order is an order to buy or sell at a specified price or better. The Limit order ensures that if the order fills, it will not fill at a price less favorable than your limit price, but it does not guarantee a fill.

Products: BOND, CASH, CFD, CMDTY, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "LMT"
order.totalQuantity = quantity
order.lmtPrice = limitPrice

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "LMT",
      "price": price,
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("LMT");
order.totalQuantity(quantity);
order.lmtPrice(limitPrice);
order.tif(TimeInForce.DAY);

Order order;
order.action = action;
order.orderType = "LMT";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "LMT";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;

Dim order As Order = New Order
order.Action = action
order.OrderType = "LMT"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice

Limit If Touched
Copy Location

A Limit if Touched is an order to buy (or sell) a contract at a specified price or better, below (or above) the market. This order is held in the system until the trigger price is touched. An LIT order is similar to a stop limit order, except that an LIT sell order is placed above the current market price, and a stop limit sell order is placed below.

Products: BOND, CASH, CFD, CMDTY, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "LIT"
order.totalQuantity = quantity
order.lmtPrice = limitPrice
order.auxPrice = triggerPrice

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "LIT",
      "price": price,
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("LIT");
order.totalQuantity(quantity);
order.lmtPrice(limitPrice);
order.auxPrice(triggerPrice);

Order order;
order.action = action;
order.orderType = "LIT";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;
order.auxPrice = triggerPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "LIT";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;
order.AuxPrice = triggerPrice;

Dim order As Order = New Order
order.Action = action
order.OrderType = "LIT"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice
order.AuxPrice = triggerPrice

Limit On Close
Copy Location

A Limit-on-close (LOC) order will be submitted at the close and will execute if the closing price is at or better than the submitted limit price.

Products: CFD, FUT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "LOC"
order.totalQuantity = quantity
order.lmtPrice = limitPrice

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "LOC",
      "price": price,
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("LOC");
order.totalQuantity(quantity);
order.lmtPrice(limitPrice);

Order order;
order.action = action;
order.orderType = "LOC";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "LOC";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;

Dim order As Order = New Order
order.Action = action
order.OrderType = "LOC"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice

Limit On Open
Copy Location

A Limit-on-Open (LOO) order combines a limit order with the OPG time in force to create an order that is submitted at the market’s open, and that will only execute at the specified limit price or better. Orders are filled in accordance with specific exchange rules.

Products: CFD, STK, OPT, WAR

More on Supported exchanges

order = Order()
order.action = action
order.tif = "OPG"
order.orderType = "LMT"
order.totalQuantity = quantity
order.lmtPrice = limitPrice

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "LMT",
      "price": price,
      "side": "side",
      "tif": "OPG",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.tif("OPG");
order.orderType("LOC");
order.totalQuantity(quantity);
order.lmtPrice(limitPrice);

Order order;
order.action = action;
order.orderType = "LMT";
order.tif = "OPG";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;

Order order = new Order();
order.Action = action;
order.Tif = "OPG";
order.OrderType = "LMT";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;

Dim order As Order = New Order
order.Action = action
order.Tif = "OPG"
order.OrderType = "LMT"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice

Limit Order With Manual Order Time
Copy Location

The Limit Order With Manual Order Time is a Limit Order with ManualOrderTime property.

Placing a Limit Order With Manual Order Time
The Manual Order Time field is required for, and becomes editable for, “manual” orders, which are orders that originate from a client (whether by phone, email, chat, verbally from the floor, from another desk, etc.) and are then entered into the system.
The Manual Order Time field is not used for client orders received electronically, nor for orders that originate from the account manager (with discretion) in the client’s accounts, or when an order is allocated to ALL accounts or among multiple accounts using an account group or model portfolio.

Canceling a Limit Order With Manual Order Time
The Manual Order Cancel Time field is required for, and becomes editable for, “manual” order cancelations, which are order cancelations that originate from a client (whether by phone, email, chat, verbally from the floor, from another desk, etc.) and are then entered into the system.
The Manual Order Cancel Time field is not used for client orders cancelations received electronically, nor for orders that originate from the account manager (with discretion) in the client’s accounts, or when an order is allocated to ALL accounts or among multiple accounts using an account group or model portfolio.

Market Orders
Copy Location

Market Order
Copy Location

A Market order is an order to buy or sell at the market bid or offer price. A market order may increase the likelihood of a fill and the speed of execution, but unlike the Limit order a Market order provides no price protection and may fill at a price far lower/higher than the current displayed bid/ask.

Products: BOND, CFD, EFP, CASH, FUND, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "MKT"
order.totalQuantity = quantity

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "MKT",
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("MKT");
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "MKT";
order.totalQuantity = quantity;

Order order = new Order();
order.Action = action;
order.OrderType = "MKT";
order.TotalQuantity = quantity;

Dim order As Order = New Order
order.Action = action
order.OrderType = "MKT"
order.TotalQuantity = quantity

Market If Touched
Copy Location

A Market If Touched (MIT) is an order to buy (or sell) a contract below (or above) the market. Its purpose is to take advantage of sudden or unexpected changes in share or other prices and provides investors with a trigger price to set an order in motion. Investors may be waiting for excessive strength (or weakness) to cease, which might be represented by a specific price point. MIT orders can be used to determine whether or not to enter the market once a specific price level has been achieved. This order is held in the system until the trigger price is touched, and is then submitted as a market order. An MIT order is similar to a stop order, except that an MIT sell order is placed above the current market price, and a stop sell order is placed below

Products: BOND, CFD, CASH, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "MIT"
order.totalQuantity = quantity
order.auxPrice = price

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "MIT",
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("MIT");
order.totalQuantity(quantity);
order.auxPrice(price);

Order order;
order.action = action;
order.orderType = "MIT";
order.totalQuantity = quantity;
order.auxPrice = price;

Order order = new Order();
order.Action = action;
order.OrderType = "MIT";
order.TotalQuantity = quantity;
order.AuxPrice = price;

Dim order As Order = New Order
order.Action = action
order.OrderType = "MIT"
order.TotalQuantity = quantity
order.AuxPrice = price

Market On Close
Copy Location

A Market On Close (MOC) order is a market order that is submitted to execute as close to the closing price as possible.

Products: CFD, FUT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "MOC"
order.totalQuantity = quantity

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "MOC",
      "side": "side",
      "tif": "DAY",
      "quantity": quantity
    }
  ]
}

order = Order()
order.action = action
order.orderType = "MOC"
order.totalQuantity = quantity

Order order;
order.action = action;
order.orderType = "MOC";
order.totalQuantity = quantity;

Order order = new Order();
order.Action = action;
order.OrderType = "MOC";
order.TotalQuantity = quantity;

Dim order As Order = New Order
order.Action = action
order.OrderType = "MOC"
order.TotalQuantity = quantity

Market On Open
Copy Location

A Market On Open (MOO) combines a market order with the OPG time in force to create an order that is automatically submitted at the market’s open and fills at the market price.

Products: CFD, FUT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "MKT"
order.totalQuantity = quantity
order.tif = "OPG"

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "MKT",
      "side": "side",
      "tif": "OPG",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("MKT");
order.totalQuantity(quantity);
order.tif("OPG");

Order order;
order.action = action;
order.orderType = "MKT";
order.totalQuantity = quantity;
order.tif = "OPG";

Order order = new Order();
order.Action = action;
order.OrderType = "MKT";
order.TotalQuantity = quantity;
order.Tif = "OPG";

Dim order As Order = New Order
order.Action = action
order.OrderType = "MKT"
order.TotalQuantity = quantity
order.Tif = "OPG"

Market to Limit
Copy Location

A Market-to-Limit (MTL) order is submitted as a market order to execute at the current best market price. If the order is only partially filled, the remainder of the order is canceled and re-submitted as a limit order with the limit price equal to the price at which the filled portion of the order executed.

Products: CFD, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "MTL"
order.totalQuantity = quantity

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("MTL");
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "MTL";
order.totalQuantity = quantity;

Order order = new Order();
order.Action = action;
order.OrderType = "MTL";
order.TotalQuantity = quantity;

Dim order As Order = New Order
order.Action = action
order.OrderType = "MTL"
order.TotalQuantity = quantity

Market with Protection
Copy Location

This order type is useful for futures traders using Globex. A Market with Protection order is a market order that will be cancelled and resubmitted as a limit order if the entire order does not immediately execute at the market price. The limit price is set by Globex to be close to the current market price, slightly higher for a sell order and lower for a buy order.

Products: FUT, FOP

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "MKT PRT"
order.totalQuantity = quantity

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("MKT PRT");
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "MKT PRT";
order.totalQuantity = quantity;

Order order = new Order();
order.Action = action;
order.OrderType = "MKT PRT";
order.TotalQuantity = quantity;

Dim order As Order = New Order
order.Action = action
order.OrderType = "MKT PRT"
order.TotalQuantity = quantity

Passive Relative
Copy Location

Passive Relative orders provide a means for traders to seek a less aggressive price than the National Best Bid and Offer (NBBO) while keeping the order pegged to the best bid (for a buy) or ask (for a sell). The order price is automatically adjusted as the markets move to keep the order less aggressive. For a buy order, your order price is pegged to the NBB by a less aggressive offset, and if the NBB moves up, your bid will also move up. If the NBB moves down, there will be no adjustment because your bid will become aggressive and execute. For a sell order, your price is pegged to the NBO by a less aggressive offset, and if the NBO moves down, your offer will also move down. If the NBO moves up, there will be no adjustment because your offer will become aggressive and execute. In addition to the offset, you can define an absolute cap, which works like a limit price, and will prevent your order from being executed above or below a specified level. The Passive Relative order is similar to the Relative/Pegged-to-Primary order, except that the Passive relative subtracts the offset from the bid and the Relative adds the offset to the bid.

Products: STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "PASSV REL"
order.totalQuantity = quantity
order.auxPrice = offset

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("PASSV REL");
order.totalQuantity(quantity);
order.auxPrice(offset);

Order order;
order.action = action;
order.orderType = "PASSV REL";
order.totalQuantity = quantity;
order.auxPrice = offset;

Order order = new Order();
order.Action = action;
order.OrderType = "PASSV REL";
order.TotalQuantity = quantity;
order.AuxPrice = offset;

Dim order As Order = New Order
order.Action = action
order.OrderType = "PASSV REL"
order.TotalQuantity = quantity
order.AuxPrice = offset

Peg Orders
Copy Location

Pegged to Benchmark
Copy Location

The Pegged to Benchmark order is similar to the Pegged to Stock order for options, except that the Pegged to Benchmark allows you to specify any asset type as the reference (benchmark) contract for a stock or option order. Both the primary and reference contracts must use the same currency.

Products: STK, OPT

More on Supported exchanges

order = Order()
order.orderType = "PEG BENCH"
#BUY or SELL
order.action = action
order.totalQuantity = quantity
#Beginning with price...
order.startingPrice = startingPrice
#increase/decrease price..
order.isPeggedChangeAmountDecrease = peggedChangeAmountDecrease
#by... (and likewise for price moving in opposite direction)
order.peggedChangeAmount = peggedChangeAmount
#whenever there is a price change of...
order.referenceChangeAmount = referenceChangeAmount
#in the reference contract...
order.referenceContractId = referenceConId
#being traded at...
order.referenceExchange = referenceExchange
#starting reference price is...
order.stockRefPrice = stockReferencePrice
#Keep order active as long as reference contract trades between...
order.stockRangeLower = referenceContractLowerRange
#and...
order.stockRangeUpper = referenceContractUpperRange

Not available for use in the Client Portal API.

Order order = new Order();
order.orderType("PEG BENCH");
//BUY or SELL
order.action(action);
order.totalQuantity(quantity);
//Beginning with price...
order.startingPrice(startingPrice);
//increase/decrease price...
order.isPeggedChangeAmountDecrease(peggedChangeAmountDecrease);
//by... (and likewise for price moving in opposite direction)
order.peggedChangeAmount(peggedChangeAmount);
//whenever there is a price change of...
order.referenceChangeAmount(referenceChangeAmount);
//in the reference contract...
order.referenceContractId(referenceConId);
//being traded at...
order.referenceExchangeId(referenceExchange);
//starting reference price is...
order.stockRefPrice(stockReferencePrice);
//Keep order active as long as reference contract trades between...
order.stockRangeLower(referenceContractLowerRange);
//and...
order.stockRangeUpper(referenceContractUpperRange);

Order order = new Order();
order.orderType("PEG BENCH");
//BUY or SELL
order.action(action);
order.totalQuantity(quantity);
//Beginning with price...
order.startingPrice(startingPrice);
//increase/decrease price...
order.isPeggedChangeAmountDecrease(peggedChangeAmountDecrease);
//by... (and likewise for price moving in opposite direction)
order.peggedChangeAmount(peggedChangeAmount);
//whenever there is a price change of...
order.referenceChangeAmount(referenceChangeAmount);
//in the reference contract...
order.referenceContractId(referenceConId);
//being traded at...
order.referenceExchangeId(referenceExchange);
//starting reference price is...
order.stockRefPrice(stockReferencePrice);
//Keep order active as long as reference contract trades between...
order.stockRangeLower(referenceContractLowerRange);
//and...
order.stockRangeUpper(referenceContractUpperRange);

Order order = new Order();
order.OrderType = "PEG BENCH";
//BUY or SELL
order.Action = action;
order.TotalQuantity = quantity;
//Beginning with price...
order.StartingPrice = startingPrice;
//increase/decrease price..
order.IsPeggedChangeAmountDecrease = peggedChangeAmountDecrease;
//by... (and likewise for price moving in opposite direction)
order.PeggedChangeAmount = peggedChangeAmount;
//whenever there is a price change of...
order.ReferenceChangeAmount = referenceChangeAmount;
//in the reference contract...
order.ReferenceContractId = referenceConId;
//being traded at...
order.ReferenceExchange = referenceExchange;
//starting reference price is...
order.StockRefPrice = stockReferencePrice;
//Keep order active as long as reference contract trades between...
order.StockRangeLower = referenceContractLowerRange;
//and...
order.StockRangeUpper = referenceContractUpperRange;

Dim order As Order = New Order
order.OrderType = "PEG BENCH"
'BUY Or SELL
order.Action = action
order.TotalQuantity = quantity
'Beginning with price...
order.StartingPrice = startingPrice
'increase/decrease price..
order.IsPeggedChangeAmountDecrease = peggedChangeAmountDecrease
'by... (And likewise for price moving in opposite direction)
order.PeggedChangeAmount = peggedChangeAmount
'whenever there Is a price change of...
order.ReferenceChangeAmount = referenceChangeAmount
'in the reference contract...
order.ReferenceContractId = referenceConId
'being traded at...
order.ReferenceExchange = referenceExchange
'starting reference price Is...
order.StockRefPrice = stockReferencePrice
'Keep order active as long as reference contract trades between...
order.StockRangeLower = referenceContractLowerRange
'And...
order.StockRangeUpper = referenceContractUpperRange

Pegged To Market
Copy Location

A pegged-to-market order is designed to maintain a purchase price relative to the national best offer (NBO) or a sale price relative to the national best bid (NBB). Depending on the width of the quote, this order may be passive or aggressive. The trader creates the order by entering a limit price which defines the worst limit price that they are willing to accept. Next, the trader enters an offset amount which computes the active limit price as follows: Sell order price = Bid price + offset amount Buy order price = Ask price – offset amount

Products: STK

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "PEG MKT"
order.totalQuantity = quantity
order.auxPrice = marketOffset#Offset price

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("PEG MKT");
order.totalQuantity(Decimal.ONE_HUNDRED);
order.auxPrice(marketOffset);//Offset price

Order order;
order.action = action;
order.orderType = "PEG MKT";
order.totalQuantity = quantity;
order.auxPrice = marketOffset;

Order order = new Order();
order.Action = action;
order.OrderType = "PEG MKT";
order.TotalQuantity = 100;
order.AuxPrice = marketOffset;//Offset price

Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG MKT"
order.TotalQuantity = 100
order.AuxPrice = marketOffset ' Offset price

Pegged To Primary / Relative
Copy Location

Relative (a.k.a. Pegged-to-Primary) orders provide a means for traders to seek a more aggressive price than the National Best Bid and Offer (NBBO). By acting as liquidity providers, and placing more aggressive bids and offers than the current best bids and offers, traders increase their odds of filling their order. Quotes are automatically adjusted as the markets move, to remain aggressive. Stocks, Options and Futures – not available on paper trading.

Products: CFD, STK, OPT, FUT

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "REL"
order.totalQuantity = quantity
order.lmtPrice = priceCap
order.auxPrice = offsetAmount

curl {baseURL}/iserver/account/{accountId}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "REL",
      "price": Limit_Price,
      "auxPrice": Offset_Price,
      "side": "side",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("REL");
order.totalQuantity(quantity);
order.lmtPrice(priceCap);
order.auxPrice(offsetAmount);

Order order;
order.action = action;
order.orderType = "REL";
order.totalQuantity = quantity;
order.lmtPrice = priceCap;
order.auxPrice = offsetAmount;

Order order = new Order();
order.Action = action;
order.OrderType = "REL";
order.TotalQuantity = quantity;
order.LmtPrice = priceCap;
order.AuxPrice = offsetAmount;

Dim order As Order = New Order
order.Action = action
order.OrderType = "REL"
order.TotalQuantity = quantity
order.LmtPrice = priceCap
order.AuxPrice = offsetAmount

Pegged To Stock
Copy Location

A Pegged to Stock order continually adjusts the option order price by the product of a signed user-define delta and the change of the option’s underlying stock price. The delta is entered as an absolute and assumed to be positive for calls and negative for puts. A buy or sell call order price is determined by adding the delta times a change in an underlying stock price to a specified starting price for the call. To determine the change in price, the stock reference price is subtracted from the current NBBO midpoint. The Stock Reference Price can be defined by the user, or defaults to the NBBO midpoint at the time of the order if no reference price is entered. You may also enter a high/low stock price range which cancels the order when reached. The delta times the change in stock price will be rounded to the nearest penny in favor of the order.

Products: OPT

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "PEG STK"
order.totalQuantity = quantity
order.delta = delta
order.stockRefPrice = stockReferencePrice
order.startingPrice = startingPrice

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("PEG STK");
order.totalQuantity(quantity);
order.delta(delta);
order.stockRefPrice(stockReferencePrice);
order.startingPrice(startingPrice);

Order order;
order.action = action;
order.orderType = "PEG STK";
order.totalQuantity = quantity;
order.delta = delta;
order.stockRefPrice = stockReferencePrice;
order.startingPrice = startingPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "PEG STK";
order.TotalQuantity = quantity;
order.Delta = delta;
order.StockRefPrice = stockReferencePrice;
order.StartingPrice = startingPrice;

Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG STK"
order.TotalQuantity = quantity
order.Delta = delta
order.StockRefPrice = stockReferencePrice
order.StartingPrice = startingPrice

Relative Limit Combo
Copy Location

Products: OPT, STK, FUT

order = Order()
order.action = action
order.totalQuantity = quantity
order.orderType = "REL + LMT"
order.lmtPrice = limitPrice

if nonGuaranteed:
	order.smartComboRoutingParams = []
	order.smartComboRoutingParams.append(TagValue("NonGuaranteed", "1"))

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("REL + LMT");
order.totalQuantity(quantity);
order.lmtPrice(limitPrice);
if (nonGuaranteed)
{
	order.smartComboRoutingParams().add(new TagValue("NonGuaranteed", "1"));
}

Order order;
order.action = action;
order.totalQuantity = quantity;
order.orderType = "Rel + LMT";
order.lmtPrice = limitPrice;
if(nonGuaranteed){
	TagValueSPtr tag1(new TagValue("NonGuaranteed", "1"));
	order.smartComboRoutingParams.reset(new TagValueList());
	order.smartComboRoutingParams->push_back(tag1);
}

Order order = new Order();
order.Action = action;
order.TotalQuantity = quantity;
order.OrderType = "REL + LMT";
order.LmtPrice = limitPrice;
if (nonGuaranteed)
{
	order.SmartComboRoutingParams = new List<TagValue>();
	order.SmartComboRoutingParams.Add(new TagValue("NonGuaranteed", "1"));
}

Dim order As Order = New Order
order.Action = action
order.TotalQuantity = quantity
order.OrderType = "REL + LMT"
order.LmtPrice = limitPrice
If (nonGuaranteed) Then
	order.SmartComboRoutingParams = New List(Of TagValue)
	order.SmartComboRoutingParams.Add(New TagValue("NonGuaranteed", "1"))
End If

Relative Market Combo
Copy Location

Products: OPT, STK, FUT

order = Order()
order.action = action
order.totalQuantity = quantity
order.orderType = "REL + MKT"

if nonGuaranteed:
	order.smartComboRoutingParams = []
	order.smartComboRoutingParams.append(TagValue("NonGuaranteed", "1"))

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("REL + MKT");
order.totalQuantity(quantity);
if (nonGuaranteed)
{
	order.smartComboRoutingParams().add(new TagValue("NonGuaranteed", "1"));
}

Order order;
order.action = action;
order.totalQuantity = quantity;
order.orderType = "Rel + MKT";
if(nonGuaranteed){
	TagValueSPtr tag1(new TagValue("NonGuaranteed", "1"));
	order.smartComboRoutingParams.reset(new TagValueList());
	order.smartComboRoutingParams->push_back(tag1);
}

Order order = new Order();
order.Action = action;
order.TotalQuantity = quantity;
order.OrderType = "REL + MKT";
if (nonGuaranteed)
{
	order.SmartComboRoutingParams = new List<TagValue>();
	order.SmartComboRoutingParams.Add(new TagValue("NonGuaranteed", "1"));
}

Dim order As Order = New Order
order.Action = action
order.TotalQuantity = quantity
order.OrderType = "REL + MKT"
If (nonGuaranteed) Then
	order.SmartComboRoutingParams = New List(Of TagValue)
	order.SmartComboRoutingParams.Add(New TagValue("NonGuaranteed", "1"))
End If

Stop
Copy Location

A Stop order is an instruction to submit a buy or sell market order if and when the user-specified stop trigger price is attained or penetrated. A Stop order is not guaranteed a specific execution price and may execute significantly away from its stop price. A Sell Stop order is always placed below the current market price and is typically used to limit a loss or protect a profit on a long stock position. A Buy Stop order is always placed above the current market price. It is typically used to limit a loss or help protect a profit on a short sale.

Products: CFD, BAG, CASH, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "STP"
order.auxPrice = stopPrice
order.totalQuantity = quantity

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "STP",
      "price": price,
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Order order = new Order();
order.action(action);
order.orderType("STP");
order.auxPrice(stopPrice);
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "STP";
order.totalQuantity = quantity;
order.auxPrice = stopPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "STP";
order.AuxPrice = stopPrice;
order.TotalQuantity = quantity;

Dim order As Order = New Order
order.Action = action
order.OrderType = "STP"
order.AuxPrice = stopPrice
order.TotalQuantity = quantity

Stop Limit
Copy Location

A Stop-Limit order is an instruction to submit a buy or sell limit order when the user-specified stop trigger price is attained or penetrated. The order has two basic components: the stop price and the limit price. When a trade has occurred at or through the stop price, the order becomes executable and enters the market as a limit order, which is an order to buy or sell at a specified price or better.

Products: CFD, CASH, FUT, FOP, OPT, STK, WAR

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "STP LMT"
order.totalQuantity = quantity
order.lmtPrice = limitPrice
order.auxPrice = stopPrice

curl --insecure https://localhost:5000/v1/api/iserver/account/{{accountId}}/orders 
--request POST 
--header 'Content-Type:application/json' 
--data '{
  "orders": [
    {
      "conid": conid,
      "orderType": "STP LMT",
      "price": price,
      "auxPrice": "auxPrice",
      "side": "side",
      "tif": "tif",
      "quantity": quantity
    }
  ]
}

Price is the Limit price while auxPrice represents the stop price trigger.

Order order = new Order();
order.action(action);
order.orderType("STP LMT");
order.lmtPrice(limitPrice);
order.auxPrice(stopPrice);
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "STP LMT";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;
order.auxPrice = stopPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "STP LMT";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;
order.AuxPrice = stopPrice;

Dim order As Order = New Order
order.Action = action
order.OrderType = "STP LMT"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice
order.AuxPrice = stopPrice

Stop with Protection
Copy Location

A Stop with Protection order combines the functionality of a stop limit order with a market with protection order. The order is set to trigger at a specified stop price. When the stop price is penetrated, the order is triggered as a market with protection order, which means that it will fill within a specified protected price range equal to the trigger price +/- the exchange-defined protection point range. Any portion of the order that does not fill within this protected range is submitted as a limit order at the exchange-defined trigger price +/- the protection points.

Products: FUT

More on Supported exchanges

order = Order()
order.totalQuantity = quantity
order.action = action
order.orderType = "STP PRT"
order.auxPrice = stopPrice

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("STP PRT");
order.auxPrice(stopPrice);
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "STP PRT";
order.totalQuantity = quantity;
order.auxPrice = stopPrice;

Order order = new Order();
order.TotalQuantity = quantity;
order.Action = action;
order.OrderType = "STP PRT";
order.AuxPrice = stopPrice;

Dim order As Order = New Order
order.TotalQuantity = quantity
order.Action = action
order.OrderType = "STP PRT"
order.AuxPrice = stopPrice

Sweep to Fill
Copy Location

Sweep-to-fill orders are useful when a trader values speed of execution over price. A sweep-to-fill order identifies the best price and the exact quantity offered/available at that price, and transmits the corresponding portion of your order for immediate execution. Simultaneously it identifies the next best price and quantity offered/available, and submits the matching quantity of your order for immediate execution.

Products: CFD, STK, WAR (SMART only)

Trailing Stop
Copy Location

For a discussion of the handling and behavior of Trailing Stop orders, please see our brokerage-wide documentation on this order type at: Trailing Stop Orders
Supported exchanges for Trailing Stop orders: Supported Exchanges

Order Type Identifier:

“TRAIL”

Parameters:

Trail Offset. Required.
Specifies the distance that your order’s stop price will maintain away from the market. A Trailing Stop order ticket must include exactly one of the following two forms of Trail Offset:

Absolute Offset: An explicit numerical value (in the instrument’s currency) which will be added to or subtracted from the market price of the instrument.
Relative Offset: A percentage of the market price of the instrument, from which absolute price offsets will be computed (which in turn may vary in size as the market price moves).

Note: The Trail Offset value, whether absolute or relative, must conform to the instrument’s price increment rules.

Stop Price.
This value is not required. If supplied, this is the trigger price beyond which the Trailing Stop order will begin its trailing behavior. If no Stop Price value is supplied, the market price for the instrument at the time of submission will assigned to this value automatically.

TWS API: Trailing Stop
Copy Location

Trail Offset. Required.
One of the following class attributes must be supplied with the order ticket.

Absolute Offset: Order.auxPrice
Relative Offset: Order.trailingPercent
Note that the value assigned to trailingPercent will be interpreted as a true percent, e.g., trailingPercent = 0.50 becomes 0.50% = 0.0050.

Stop Price: Order.trailStopPrice

In the example to the right, we have outlined two Trailing Stop orders with explicit Stop Prices via order.trailStopPrice.
In the first order, we supply a relative offset of 2% using order.TrailStopPercent.
In the second order, we supply an absolute offset of 3 units of currency using order.auxPrice.

order = Order()
order.orderType = "TRAIL"
order.trailStopPrice = 100
order.trailingPercent = 2

order = Order()
order.orderType = "TRAIL"
order.trailStopPrice = 100
order.auxPrice = 3

Order order = new Order();
order.orderType("TRAIL");
order.trailStopPrice(100);
order.trailingPercent(2);

Order order = new Order();
order.orderType("TRAIL");
order.trailStopPrice(100);
order.auxPrice(3);

Order order;
order.orderType = "TRAIL";
order.trailStopPrice = 100;
order.trailingPercent = 2;

Order order;
order.orderType = "TRAIL";
order.trailStopPrice = 100;
order.auxPrice = 3;

Order order = new Order();
order.OrderType = "TRAIL";
order.TrailStopPrice = 100;
order.TrailingPercent = 2;

Order order = new Order();
order.OrderType = "TRAIL";
order.TrailStopPrice = 100;
order.AuxPrice= 3;

Dim order As Order = New Order
order.OrderType = "TRAIL"
order.TrailStopPrice = 100
order.TrailingPercent = 2

Dim order As Order = New Order
order.OrderType = "TRAIL"
order.TrailStopPrice = 100
order.AuxPrice= 3

CP API: Trailing Stop
Copy Location

Trail Offset. Required.
One of the following approaches to Trail Offset specification must be used with the order ticket.

Absolute Offset: "trailingType": "amt", "trailingAmt": {{currency}}
Relative Offset: "trailingType": "%", "trailingAmt": {{number 0 to 100}}
Note that you must pass a literal % character as the value of the trailingType field in order to use a percentage trailingAmt value.

Stop Price: "price"

In the example to the right, we have outlined two Trailing Stop orders with explicit Stop Prices via the price field.
In the first order, we supply a relative offset of 2% using "trailingType": "%" and "trailingAmt": 2.
In the second order, we supply an absolute offset of 3 units of currency using "trailingType": "amt" and "trailingAmt": 3.

{
  "orderType": "TRAIL",
  "price": 100,
  "trailingAmt": 2,
  "trailingType": "%"
}

{
  "orderType": "TRAIL",
  "price": 100,
  "trailingAmt": 3,
  "trailingType": "amt"
}

Trailing Stop Limit
Copy Location

A trailing stop limit order is designed to allow an investor to specify a limit on the maximum possible loss, without setting a limit on the maximum possible gain. A SELL trailing stop limit moves with the market price, and continually recalculates the stop trigger price at a fixed amount below the market price, based on the user-defined “trailing” amount. The limit order price is also continually recalculated based on the limit offset. As the market price rises, both the stop price and the limit price rise by the trail amount and limit offset respectively, but if the stock price falls, the stop price remains unchanged, and when the stop price is hit a limit order is submitted at the last calculated limit price. A “Buy” trailing stop limit order is the mirror image of a sell trailing stop limit, and is generally used in falling markets.

Trailing Stop Limit orders can be sent with the trailing amount specified as an absolute amount, as in the example below, or as a percentage, specified in the trailingPercent field.

Important: the ‘limit offset’ field is set by default in the TWS/IBG settings. This setting either needs to be changed in the Order Presets, the default value accepted, or the limit price offset sent from the API as in the example below. Not both the ‘limit price’ and ‘limit price offset’ fields can be set in TRAIL LIMIT orders.

Products: BOND, CFD, CASH, FUT, FOP, OPT, STK, WAR

Volatility
Copy Location

Specific to US options, investors are able to create and enter Volatility-type orders for options and combinations rather than price orders. Option traders may wish to trade and position for movements in the price of the option determined by its implied volatility. Because implied volatility is a key determinant of the premium on an option, traders position in specific contract months in an effort to take advantage of perceived changes in implied volatility arising before, during or after earnings or when company specific or broad market volatility is predicted to change. In order to create a Volatility order, clients must first create a Volatility Trader page from the Trading Tools menu and as they enter option contracts, premiums will display in percentage terms rather than premium. The buy/sell process is the same as for regular orders priced in premium terms except that the client can limit the volatility level they are willing to pay or receive.

Products: FOP, OPT

More on Supported exchanges

order = Order()
order.action = action
order.orderType = "VOL"
order.totalQuantity = quantity
order.volatility = volatilityPercent#Expressed in percentage (40%)
order.volatilityType = volatilityType# 1=daily, 2=annual

Not available for use in the Client Portal API.

Order order = new Order();
order.action(action);
order.orderType("VOL");
order.volatility(volatilityPercent);//Expressed in percentage (40%)
order.volatilityType(volatilityType);// 1=daily, 2=annual
order.totalQuantity(quantity);

Order order;
order.action = action;
order.orderType = "VOL";
order.totalQuantity = quantity;
order.volatility = volatilityPercent; //Expressed in percentage (40%)
order.volatilityType = volatilityType; // 1=daily, 2=annual

Order order = new Order();
order.Action = action;
order.OrderType = "VOL";
order.TotalQuantity = quantity;
order.Volatility = volatilityPercent;//Expressed in percentage (40%)
order.VolatilityType = volatilityType;// 1=daily, 2=annual

Dim order As Order = New Order
order.Action = action
order.OrderType = "VOL"
order.TotalQuantity = quantity
order.Volatility = volatilityPercent  'Expressed in percentage (40%)
order.VolatilityType = volatilityType  ' 1=daily, 2=annual

Complex Orders
Copy Location

Adjustable Stops
Copy Location

You can attach one-time adjustments to stop, stop limit, trailing stop and trailing stop limit orders. When you attach an adjusted order, you set a trigger price that triggers a modification of the original (or parent) order, instead of triggering order transmission.

You can adjust any of the parent stop order types to any other stop order type; for example if you set up a Stop Limit, you can attach the one-time adjustment to change the order to a Trailing Stop, or if you start with a Stop order the adjustment can change it to a Trailing Stop Limit order.

Adjusted to Stop
Copy Location

TriggerPrice: Price threshold for when the order type should just to the AdjustedOrderType value.

AdjustedOrderType: Resulting order type in the event an order passes the triggerPrice threshold.
This can be “STP”, “STP LMT”, “TRAIL”, “TRAILING LIMIT”

AdjustedStopPrice: The stop order’s trigger price after being adjusted.

order = Order()
order.orderType = "TRAIL"
order.trailStopPrice = 100
order.auxPrice = 3

order.triggerPrice = triggerPrice
order.adjustedOrderType = "STP"
order.adjustedStopPrice = adjustStopPrice

Order order = new Order();
order.orderType("TRAIL");
order.trailStopPrice(100);
order.trailingPercent(2);

order.triggerPrice(triggerPrice);
order.adjustedOrderType(OrderType.STP);
order.adjustedStopPrice(adjustStopPrice);

Order order;
order.orderType = "TRAIL";
order.trailStopPrice = 100;
order.trailingPercent = 2;

order.triggerPrice = triggerPrice;
order.adjustedOrderType = "STP";
order.adjustedStopPrice = adjustStopPrice;

Order order = new Order();
order.OrderType = "TRAIL";
order.TrailStopPrice = 100;
order.TrailingPercent = 2;

order.TriggerPrice = triggerPrice;
order.AdjustedOrderType = "STP";
order.AdjustedStopPrice = adjustStopPrice;

Dim order As Order = New Order
order.OrderType = "TRAIL"
order.TrailStopPrice = 100
order.TrailingPercent = 2

order.TriggerPrice = triggerPrice
order.AdjustedOrderType = "STP"
order.AdjustedStopPrice = adjustStopPrice

Adjusted to Stop Limit
Copy Location

TriggerPrice: Price threshold for when the order type should just to the AdjustedOrderType value.

AdjustedOrderType: Resulting order type in the event an order passes the triggerPrice threshold.
This can be “STP”, “STP LMT”, “TRAIL”, “TRAILING LIMIT”

AdjustedStopPrice: The stop order’s trigger price after being adjusted.

AdjustedStopLimitPrice: The stop order’s limit price for execution after being adjusted.

order = Order()
order.orderType = "TRAIL"
order.trailStopPrice = 100
order.auxPrice = 3

order.triggerPrice = triggerPrice
order.adjustedOrderType = "STP LMT"
order.adjustedStopPrice = adjustStopPrice
order.adjustedStopLimitPrice = adjustedStopLimitPrice

Order order = new Order();
order.orderType("TRAIL");
order.trailStopPrice(100);
order.trailingPercent(2);

order.triggerPrice(triggerPrice);
order.adjustedOrderType("STP LMT");
order.adjustedStopPrice(adjustStopPrice);
order.adjustStopLimitPrice(adjustStopLimitPrice);

Order order;
order.orderType = "TRAIL";
order.trailStopPrice = 100;
order.trailingPercent = 2;

order.triggerPrice = triggerPrice;
order.adjustedOrderType = "STP LMT";
order.adjustedStopPrice = adjustStopPrice;
order.adjustedStopLimitPrice = adjustedStopLimitPrice;

Order order = new Order();
order.OrderType = "TRAIL";
order.TrailStopPrice = 100;
order.TrailingPercent = 2;

order.TriggerPrice = triggerPrice;
order.AdjustedOrderType = "STP LMT";
order.AdjustedStopPrice = adjustStopPrice;
order.AdjustedStopLimitPrice = adjustedStopLimitPrice;

Dim order As Order = New Order
order.OrderType = "TRAIL"
order.TrailStopPrice = 100
order.TrailingPercent = 2

order.TriggerPrice = triggerPrice
order.AdjustedOrderType = "STP LMT"
order.AdjustedStopPrice = adjustStopPrice
order.AdjustedStopLimitPrice = adjustedStopLimitPrice

Adjusted to Trail
Copy Location

TriggerPrice: Price threshold for when the order type should just to the AdjustedOrderType value.

AdjustedOrderType: Resulting order type in the event an order passes the triggerPrice threshold.
This can be “STP”, “STP LMT”, “TRAIL”, “TRAILING LIMIT”.

AdjustedStopPrice: The trail order’s trigger price after being adjusted.

AdjustableTrailingUnit: Dictate how trail should be adjusted.
This can be “amt” or “%”.

AdjustedTrailingAmount: The value to trail by. This will be a set amount or percentage based on the AdjustedTrailingUnit.

order = Order()
order.action = action
order.orderType = "STP"
order.auxPrice = stopPrice
order.totalQuantity = quantity

order.triggerPrice = triggerPrice
order.adjustedOrderType = "TRAIL"
order.adjustedStopPrice = adjustedStopPrice
order.adjustableTrailingUnit = trailUnit
order.adjustedTrailingAmount = adjustedTrailAmount

Order order = new Order();
order.action(action);
order.orderType("STP");
order.auxPrice(stopPrice);
order.totalQuantity(quantity);

order.triggerPrice(triggerPrice);
order.adjustedOrderType("TRAIL");
order.adjustedStopPrice(adjustStopPrice);
order.adjustableTrailingUnit(trailUnit);
order.adjustedTrailingAmount(adjustedTrailAmount);

Order order;
order.action = action;
order.orderType = "STP";
order.totalQuantity = quantity;
order.auxPrice = stopPrice;

order.triggerPrice = triggerPrice;
order.adjustedOrderType = "TRAIL";
order.adjustedStopPrice = adjustStopPrice;
order.adjustableTrailingUnit = trailUnit;
order.adjustedTrailingAmount = adjustedTrailAmount;

Order order = new Order();
order.Action = action;
order.OrderType = "STP";
order.AuxPrice = stopPrice;
order.TotalQuantity = quantity;

order.TriggerPrice = triggerPrice;
order.AdjustedOrderType = "TRAIL";
order.AdjustedStopPrice = adjustedStopPrice;
order.AdjustableTrailingUnit = trailUnit;
order.AdjustedTrailingAmount = adjustedTrailAmount;

Dim order As Order = New Order
order.Action = action
order.OrderType = "STP"
order.AuxPrice = stopPrice
order.TotalQuantity = quantity

'Adjusted Stop Component
order.TriggerPrice = triggerPrice
order.AdjustedOrderType = "TRAIL"
order.AdjustedStopPrice = adjustedStopPrice
order.AdjustableTrailingUnit = trailUnit
order.AdjustedTrailingAmount = adjustedTrailAmount

Adjusted to Trail Limit
Copy Location

TriggerPrice: Price threshold for when the order type should just to the AdjustedOrderType value.

AdjustedOrderType: Resulting order type in the event an order passes the triggerPrice threshold.
This can be “STP”, “STP LMT”, “TRAIL”, “TRAILING LIMIT”.

AdjustedStopPrice: The trail order’s trigger price after being adjusted.

AdjustedStopLimitPrice: The trailing order’s limit price for execution after being adjusted.

AdjustableTrailingUnit: Dictate how trail should be adjusted.
This can be “amt” or “%”.

AdjustedTrailingAmount: The value to trail by. This will be a set amount or percentage based on the AdjustedTrailingUnit.

order = Order()
order.action = action
order.orderType = "STP"
order.auxPrice = stopPrice
order.totalQuantity = quantity

order.triggerPrice = triggerPrice
order.adjustedOrderType = "TRAIL LIMIT"
order.adjustedStopPrice = adjustedStopPrice
order.adjustedStopLimitPrice = adjustedStopLimitPrice
order.adjustableTrailingUnit = trailUnit
order.adjustedTrailingAmount = adjustedTrailAmount

Order order = new Order();
order.action(action);
order.orderType("STP");
order.auxPrice(stopPrice);
order.totalQuantity(quantity);

order.triggerPrice(triggerPrice);
order.adjustedOrderType("TRAIL LIMIT");
order.adjustedStopPrice(adjustStopPrice);
order.adjustStopLimitPrice(adjustStopLimitPrice);
order.adjustableTrailingUnit(trailUnit);
order.adjustedTrailingAmount(adjustedTrailAmount);

Order order;
order.action = action;
order.orderType = "STP";
order.totalQuantity = quantity;
order.auxPrice = stopPrice;

order.triggerPrice = triggerPrice;
order.adjustedOrderType = "TRAIL LIMIT";
order.adjustedStopPrice = adjustStopPrice;
order.adjustedStopLimitPrice = adjustedStopLimitPrice;
order.adjustableTrailingUnit = trailUnit;
order.adjustedTrailingAmount = adjustedTrailAmount;

Order order = new Order();
order.Action = action;
order.OrderType = "STP";
order.AuxPrice = stopPrice;
order.TotalQuantity = quantity;

order.TriggerPrice = triggerPrice;
order.AdjustedOrderType = "TRAIL LIMIT";
order.AdjustedStopPrice = adjustedStopPrice;
order.AdjustedStopLimitPrice = adjustedStopLimitPrice;
order.AdjustableTrailingUnit = trailUnit;
order.AdjustedTrailingAmount = adjustedTrailAmount;

Dim order As Order = New Order
order.Action = action
order.OrderType = "STP"
order.AuxPrice = stopPrice
order.TotalQuantity = quantity

'Adjusted Stop Component
order.TriggerPrice = triggerPrice
order.AdjustedOrderType = "TRAIL LIMIT"
order.AdjustedStopPrice = adjustedStopPrice
order.AdjustedStopLimitPrice = adjustedStopLimitPrice
order.AdjustableTrailingUnit = trailUnit
order.AdjustedTrailingAmount = adjustedTrailAmount

Hedging
Copy Location

Hedging orders are similar to Bracket Orders. With hedging order, a child order is submitted only on execution of the parent. Orders can be hedged by an attached forex trade, Beta hedge, or Pair Trade, just as in TWS.

For an example of a forex hedge, when buying a contract on a currency other than your base, you can attach an FX order to convert base currency to the currency of the contract to cover the cost of the trade thanks to the TWS API’s Attaching Orders mechanism.

Bracket Orders
Copy Location

Bracket Orders are designed to help limit your loss and lock in a profit by “bracketing” an order with two opposite-side orders. A BUY order is bracketed by a high-side sell limit order and a low-side sell stop order. A SELL order is bracketed by a high-side buy stop order and a low side buy limit order. Note how bracket orders make use of the TWS API’s Attaching Orders mechanism.

One key thing to keep in mind is to handle the order transmission accurately. Since a Bracket consists of three orders, there is always a risk that at least one of the orders gets filled before the entire bracket is sent. To avoid it, make use of the IBApi.Order.Transmit flag. When this flag is set to ‘false’, the TWS will receive the order but it will not send (transmit) it to the servers. In the example below, the first (parent) and second (takeProfit) orders will be send to the TWS but not transmitted to the servers. When the last child order (stopLoss) is sent however and given that its IBApi.Order.Transmit flag is set to true, the TWS will interpret this as a signal to transmit not only its parent order but also the rest of siblings, removing the risks of an accidental execution.

One Cancels All
Copy Location

The One-Cancels All (OCA) order type allows an investor to place multiple and possibly unrelated orders assigned to a group. The aim is to complete just one of the orders, which in turn will cause TWS to cancel the remaining orders.

The investor may submit several orders aimed at taking advantage of the most desirable price within the group. Completion of one piece of the group order causes cancellation of the remaining group orders while partial completion causes the group to re-balance.

An investor might desire to sell 1000 shares of only ONE of three positions held above prevailing market prices. The OCA order group allows the investor to enter prices at specified target levels and if one is completed, the other two will automatically cancel. Alternatively, an investor may wish to take a LONG position in eMini S&P stock index futures in a falling market or else SELL US treasury futures at a more favorable price.

Grouping the two orders using an OCA order type offers the investor two chances to enter a similar position, while only running the risk of taking on a single position.

Multiple OCA types cannot be used in a single OCA Group.

OCA Types
Copy Location

Via the IBApi.Order.OcaType attribute, the way in which remaining orders should be handled after an execution can be configured as indicated in the table.

Value	Description
1	Cancel all remaining orders with block.*
2	Remaining orders are proportionately reduced in size with block.*
3	Remaining orders are proportionately reduced in size with no block.

Note*: if you use a value “with block” it gives the order overfill protection. This means that only one order in the group will be routed at a time to remove the possibility of an overfill. Click here for further discussion of OCA orders.

Multiple OCA types cannot be used in a single OCA Group.

Order Conditioning
Copy Location

Order Conditions are a set of parameters attached to an order that allow the order to either be placed or cancel upon achieving the condition criteria. There are 6 unique Order Conditions that can be applied to a given order: Price, Time, Margin, Execution, Volume, and PercentChange.

Order Conditions can be applied to nearly any order and more than one condition can be attached to an individual order using to be Inclusive, “AND”, or Exclusive, “OR”.

More information on Order Conditions can be found here.

For the sake of simplicity, all Condition Orders below will be based on an example order, shown here. The additional content will be included in each order’s content.

base_order = Order()
base_order.action = action
base_order.orderType = "MKT"
base_order.totalQuantity = quantity
base_order.conditionsCancelOrder = False

Order base_order= new Order();
base_order.action(action);
base_order.orderType("MKT");
base_order.totalQuantity(quantity);
base_order.conditionsCancelOrder(false);

Order base_order;
base_order.action = action;
base_order.orderType = "MKT";
base_order.totalQuantity = quantity;
base_order.conditionsCancelOrder = false;

Order base_order= new Order();
base_order.Action = action;
base_order.OrderType = "MKT";
base_order.TotalQuantity = quantity;
base_order.ConditionsCancelOrder = false;

Dim base_order As Order = New Order
base_order.Action = action
base_order.OrderType = "MKT"
base_order.TotalQuantity = quantity
base_order.ConditionsCancelOrder = false

Execution Conditions
Copy Location

The Execution Condition triggers an order whenever another order on your account has executed. The parameters allow the developer to specify how narrow a scope will trigger a condition.

See ExecutionCondition for more details on the ExecutionCondition class.

execCondition = order_condition.Create(OrderCondition.Execution)
execCondition.symbol = symbol
execCondition.exchange = exchange
execCondition.secType = secType

base_order.conditions = [execCondition]

 ExecutionCondition execCondition = (ExecutionCondition)OrderCondition.create(OrderConditionType.Execution);
execCondition.symbol(symbol);
execCondition.exchange(exchange);
execCondition.secType(secType);
execCondition.conjunctionConnection(isConjunction);

base_order.conditions().add(execCondition)

 ExecutionCondition* execCondition = dynamic_cast<ExecutionCondition *>(OrderCondition::create(OrderCondition::OrderConditionType::Execution));
execCondition->symbol(symbol);
execCondition->exchange(exchange);
execCondition->secType(secType);
execCondition->conjunctionConnection(isConjunction);

base_order.conditions->push_back(execCondition)

ExecutionCondition execCondition = (ExecutionCondition)OrderCondition.Create(OrderConditionType.Execution);
//When an execution on symbol
execCondition.Symbol = symbol;
execCondition.Exchange = exchange;
execCondition.SecType = secType;
execCondition.IsConjunctionConnection = isConjunction;

base_order.Conditions = new List();
base_order.Conditions.Add(execCondition);

Dim execCondition As ExecutionCondition = OrderCondition.Create(OrderConditionType.Execution) ' cast to (ExecutionCondition)
execCondition.Symbol = symbol
execCondition.Exchange = exchange
execCondition.SecType = secType
execCondition.IsConjunctionConnection = isConjunction

base_order.Conditions = New List()
base_order.Conditions.Add(execCondition)

Margin Conditions
Copy Location

Margin Conditions permit users to ready an order in case their order starts falling to a given threshold that may lead to liquidation or to submit an order after ample margin cushion has been established.

See MarginCondition for more details on the MarginCondition class.

marginCondition = order_condition.Create(OrderCondition.Margin)
marginCondition.isMore = isMore
marginCondition.percent = percent
marginCondition.isConjunctionConnection = isConjunction

base_order.conditions = [marginCondition]

MarginCondition marginCondition = (MarginCondition)OrderCondition.create(OrderConditionType.Margin);
marginCondition.isMore(isMore);
marginCondition.percent(percent);
marginCondition.conjunctionConnection(isConjunction);

base_order.conditions().add(marginCondition)

MarginCondition* marginCondition = dynamic_cast<MarginCondition *>(OrderCondition::create(OrderCondition::OrderConditionType::Margin));
marginCondition->percent(percent);
marginCondition->isMore(isMore);
marginCondition->conjunctionConnection(isConjunction);

base_order.conditions->push_back(marginCondition);

MarginCondition marginCondition = (MarginCondition)OrderCondition.Create(OrderConditionType.Margin);
marginCondition.IsMore = isMore;
marginCondition.Percent = percent;
marginCondition.IsConjunctionConnection = isConjunction;

base_order.Conditions = new List();
base_order.Conditions.Add(marginCondition);

Dim _MarginCondition As MarginCondition = OrderCondition.Create(OrderConditionType.Margin) ' cast to (MarginCondition)
_MarginCondition.IsMore = isMore
_MarginCondition.Percent = percent
_MarginCondition.IsConjunctionConnection = isConjunction

base_order.Conditions = New List()
base_order.Conditions.Add(_MarginCondition)

Price Conditions
Copy Location

A Price Condition will trigger if an order should transmit or cancel when a given contract’s price goes above or beyond a given threshold.

See PriceCondition for more details on the PriceCondition class.

priceCondition = PriceCondition()
priceCondition.conId = conId
priceCondition.exchange = exchange
priceCondition.isMore = isMore
priceCondition.triggerMethod = triggerMethod
priceCondition.price = price

base_order.conditions = [priceCondition]

PriceCondition priceCondition = (PriceCondition)OrderCondition.create(OrderConditionType.Price);
priceCondition.conId(conId);
priceCondition.exchange(exchange);
priceCondition.isMore(isMore);
priceCondition.price(price);
priceCondition.conjunctionConnection(isConjunction);

base_order.conditions().add(priceCondition)

PriceCondition* priceCondition = dynamic_cast<PriceCondition *>(OrderCondition::create(OrderCondition::OrderConditionType::Price));
priceCondition->conId(conId);
priceCondition->exchange(exchange);
priceCondition->isMore(isMore);
priceCondition->price(price);
priceCondition->conjunctionConnection(isConjunction);

base_order.conditions->push_back(priceCondition);

PriceCondition priceCondition = (PriceCondition)OrderCondition.Create(OrderConditionType.Price);
priceCondition.ConId = conId;
priceCondition.Exchange = exchange;
priceCondition.IsMore = isMore;
priceCondition.Price = price;
priceCondition.IsConjunctionConnection = isConjunction;

base_order.Conditions = new List();
base_order.Conditions.Add(priceCondition);

Dim _priceCondition As PriceCondition = OrderCondition.Create(OrderConditionType.Price) 
_priceCondition.ConId = conId
_priceCondition.Exchange = exchange
_priceCondition.IsMore = isMore
_priceCondition.Price = price
_priceCondition.IsConjunctionConnection = isConjunction

base_order.Conditions = New List()
base_order.Conditions.Add(_priceCondition)

Percentage Conditions
Copy Location

The Percent Change Condition will trigger if there is a price percent change measured against last close price.

See PercentChangeCondition for more details on the PercentChangeCondition class.

 pctChangeCondition = order_condition.Create(OrderCondition.PercentChange)
pctChangeCondition.isMore = isMore
pctChangeCondition.changePercent = pctChange
pctChangeCondition.conId = conId
pctChangeCondition.exchange = exchange
pctChangeCondition.isConjunctionConnection = isConjunction

base_order.conditions = [pctChangeCondition]

PercentChangeCondition pctChangeCondition = (PercentChangeCondition)OrderCondition.create(OrderConditionType.PercentChange);
pctChangeCondition.isMore(isMore);
pctChangeCondition.changePercent(pctChange);
pctChangeCondition.conId(conId);
pctChangeCondition.exchange(exchange);
pctChangeCondition.conjunctionConnection(isConjunction);

base_order.conditions().add(pctChangeCondition)

PercentChangeCondition* pctChangeCondition = dynamic_cast<PercentChangeCondition *>(OrderCondition::create(OrderCondition::OrderConditionType::PercentChange));
pctChangeCondition->isMore(isMore);
pctChangeCondition->changePercent(pctChange);
pctChangeCondition->conId(conId);
pctChangeCondition->exchange(exchange);
pctChangeCondition->conjunctionConnection(isConjunction);

base_order.conditions->push_back(pctChangeCondition);

PercentChangeCondition pctChangeCondition = (PercentChangeCondition)OrderCondition.Create(OrderConditionType.PercentCange);
pctChangeCondition.IsMore = isMore;
pctChangeCondition.ChangePercent = pctChange;
pctChangeCondition.ConId = conId;
pctChangeCondition.Exchange = exchange;
pctChangeCondition.IsConjunctionConnection = isConjunction;

base_order.Conditions = new List();
base_order.Conditions.Add(pctChangeCondition);

Dim pctChangeCondition As PercentChangeCondition = OrderCondition.Create(OrderConditionType.PercentCange)
pctChangeCondition.IsMore = isMore
pctChangeCondition.ChangePercent = pctChange
pctChangeCondition.ConId = conId
pctChangeCondition.Exchange = exchange
pctChangeCondition.IsConjunctionConnection = isConjunction

base_order.Conditions = New List()
base_order.Conditions.Add(pctChangeCondition)

Time Conditions
Copy Location

The Time Condition will trigger an order for submission or cancellation after a time has been reached.

See TimeCondition for more details on the TimeCondition class.

timeCondition = order_condition.Create(OrderCondition.Time)
timeCondition.isMore = isMore
timeCondition.time = time   
timeCondition.isConjunctionConnection = isConjunction

base_order.conditions = [timeCondition]

TimeCondition timeCondition = (TimeCondition)OrderCondition.create(OrderConditionType.Time);
timeCondition.isMore(isMore);
timeCondition.time(time);
timeCondition.conjunctionConnection(isConjunction);

base_order.conditions().add(timeCondition)

TimeCondition* timeCondition = dynamic_cast<TimeCondition *>(OrderCondition::create(OrderCondition::OrderConditionType::Time));
timeCondition->isMore(isMore);
timeCondition->time(time);
timeCondition->conjunctionConnection(isConjunction);

base_order.conditions->push_back(timeCondition);

TimeCondition timeCondition = (TimeCondition)OrderCondition.Create(OrderConditionType.Time);
timeCondition.IsMore = isMore;
timeCondition.Time = time;
timeCondition.IsConjunctionConnection = isConjunction;

base_order.Conditions = new List();
base_order.Conditions.Add(timeCondition);

Dim _TimeCondition As TimeCondition = OrderCondition.Create(OrderConditionType.Time)
_TimeCondition.IsMore = isMore
_TimeCondition.Time = time
_TimeCondition.IsConjunctionConnection = isConjunction

base_order.Conditions = New List()
base_order.Conditions.Add(_TimeCondition)

Volume Conditions
Copy Location

Volume Condition will trigger in the event the contract’s volume remains above or below a given threshold.

Note: VolumeCondition orders must be SMART routed.

See VolumeCondition for more details on the VolumeCondition class.

volCond = order_condition.Create(OrderCondition.Volume)
volCond.conId = conId
volCond.exchange = exchange
volCond.isMore = isMore
volCond.volume = volume
volCond.isConjunctionConnection = isConjunction

VolumeCondition volCon = (VolumeCondition)OrderCondition.create(OrderConditionType.Volume);
volCon.conId(conId);
volCon.exchange(exchange);
volCon.isMore(isMore);
volCon.volume(volume);
volCon.conjunctionConnection(isConjunction);

VolumeCondition* volCondition = dynamic_cast<VolumeCondition *>(OrderCondition::create(OrderCondition::OrderConditionType::Volume));
volCondition->conId(conId);
volCondition->exchange(exchange);
volCondition->isMore(isMore);
volCondition->volume(volume);
volCondition->conjunctionConnection(isConjunction);

VolumeCondition volCond = (VolumeCondition)OrderCondition.Create(OrderConditionType.Volume);
//Whenever contract...
volCond.ConId = conId;
//When traded at
volCond.Exchange = exchange;
//reaches a volume higher/lower
volCond.IsMore = isMore;
//than this...
volCond.Volume = volume;
//AND | OR next condition (will be ignored if no more conditions are added)
volCond.IsConjunctionConnection = isConjunction;

 Dim volCond As VolumeCondition = OrderCondition.Create(OrderConditionType.Volume) 'cast (VolumeCondition)
'Whenever contract...
volCond.ConId = conId
'When traded at
volCond.Exchange = exchange
'reaches a volume higher/lower
volCond.IsMore = isMore
'than this...
volCond.Volume = volume
'And | Or next condition (will be ignored if no more conditions are added)
volCond.IsConjunctionConnection = isConjunction

IBKRATS Order Types
Copy Location

Customers can direct non-marketable U.S. stock orders to the IBKRATS destination to add liquidity. Orders directed to IBKRATS are tagged as “not held” orders, and are posted in IBKR’s order book where incoming SmartRouted orders from other IBKR customers are eligible to take liquidity by trading against them.
To route an order to IBKRATS via the API, you need to set the IBApi::Contract::Exchange field to “IBKRATS” and IBApi::Order::NotHeld to True.

Pegged-to-Best
Copy Location

order = Order()
order.action = action
order.orderType = "PEG BEST"
order.lmtPrice = limitPrice
order.totalQuantity = quantity
order.notHeld = True
order.minTradeQty = minTradeQty
order.minCompeteSize = minCompeteSize
order.competeAgainstBestOffset = competeAgainstBestOffset

Order order = new Order();
order.action(action);
order.orderType("PEG BEST");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
order.notHeld(true);
order.minTradeQty(minTradeQty);
order.minCompeteSize(minCompeteSize);
order.competeAgainstBestOffset(competeAgainstBestOffset);

Order order;
order.action = action;
order.orderType = "PEG BEST";
order.lmtPrice = limitPrice;
order.totalQuantity = quantity;
order.notHeld = true;
order.minTradeQty = minTradeQty;
order.minCompeteSize = minCompeteSize;
order.competeAgainstBestOffset = competeAgainstBestOffset;

Order order = new Order();
order.Action = action;
order.OrderType = "PEG BEST";
order.LmtPrice = limitPrice;
order.TotalQuantity = quantity;
order.NotHeld = true;
order.MinTradeQty = minTradeQty;
order.MinCompeteSize = minCompeteSize;
order.CompeteAgainstBestOffset = competeAgainstBestOffset;

Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG BEST"
order.LmtPrice = limitPrice
order.TotalQuantity = quantity
order.NotHeld = True
order.MinTradeQty = minTradeQty
order.MinCompeteSize = minCompeteSize
order.CompeteAgainstBestOffset = competeAgainstBestOffset

Pegged-to-Best offset difference
Copy Location

order = Order()
order.action = action
order.orderType = "PEG BEST"
order.lmtPrice = limitPrice
order.totalQuantity = quantity
order.notHeld = True
order.minTradeQty = minTradeQty
order.minCompeteSize = minCompeteSize
order.competeAgainstBestOffset = COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID
order.midOffsetAtWhole = midOffsetAtWhole
order.midOffsetAtHalf = midOffsetAtHalf

Order order = new Order();
order.action(action);
order.orderType("PEG BEST");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
order.notHeld(true);
order.minTradeQty(minTradeQty);
order.minCompeteSize(minCompeteSize);
order.competeAgainstBestOffset(Order.COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID);
order.midOffsetAtWhole(midOffsetAtWhole);
order.midOffsetAtHalf(midOffsetAtHalf);

Order order;
order.action = action;
order.orderType = "PEG BEST";
order.lmtPrice = limitPrice;
order.totalQuantity = quantity;
order.notHeld = true;
order.minTradeQty = minTradeQty;
order.minCompeteSize = minCompeteSize;
order.competeAgainstBestOffset = COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID;
order.midOffsetAtWhole = midOffsetAtWhole;
order.midOffsetAtHalf = midOffsetAtHalf;

Order order = new Order();
order.Action = action;
order.OrderType = "PEG BEST";
order.LmtPrice = limitPrice;
order.TotalQuantity = quantity;
order.NotHeld = true;
order.MinTradeQty = minTradeQty;
order.MinCompeteSize = minCompeteSize;
order.CompeteAgainstBestOffset = Order.COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID;
order.MidOffsetAtWhole = midOffsetAtWhole;
order.MidOffsetAtHalf = midOffsetAtHalf;

Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG BEST"
order.LmtPrice = limitPrice
order.TotalQuantity = quantity
order.NotHeld = True
order.MinTradeQty = minTradeQty
order.MinCompeteSize = minCompeteSize
order.CompeteAgainstBestOffset = Order.COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID
order.MidOffsetAtWhole = midOffsetAtWhole
order.MidOffsetAtHalf = midOffsetAtHalf

Pegged-to-Midpoint
Copy Location

order = Order()
order.action = action
order.orderType = "PEG MID"
order.lmtPrice = limitPrice
order.totalQuantity = quantity
order.notHeld = True
order.minTradeQty = minTradeQty
order.midOffsetAtWhole = midOffsetAtWhole
order.midOffsetAtHalf = midOffsetAtHalf

Order order = new Order();
order.action(action);
order.orderType("PEG MID");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
order.notHeld(true);
order.minTradeQty(minTradeQty);
order.midOffsetAtWhole(midOffsetAtWhole);
order.midOffsetAtHalf(midOffsetAtHalf);

Order order;
order.action = action;
order.orderType = "PEG MID";
order.lmtPrice = limitPrice;
order.totalQuantity = quantity;
order.notHeld = true;
order.minTradeQty = minTradeQty;
order.midOffsetAtWhole = midOffsetAtWhole;
order.midOffsetAtHalf = midOffsetAtHalf;

Order order = new Order();
order.Action = action;
order.OrderType = "PEG MID";
order.LmtPrice = limitPrice;
order.TotalQuantity = quantity;
order.NotHeld = true;
order.MinTradeQty = minTradeQty;
order.MidOffsetAtWhole = midOffsetAtWhole;
order.MidOffsetAtHalf = midOffsetAtHalf;

Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG MID"
order.LmtPrice = limitPrice
order.TotalQuantity = quantity
order.NotHeld = True
order.MinTradeQty = minTradeQty
order.MidOffsetAtWhole = midOffsetAtWhole
order.MidOffsetAtHalf = midOffsetAtHalf

Algorithmic Orders
Copy Location

Order types and algos may help limit risk, speed execution, provide price improvement, allow privacy, time the market and simplify the trading process through advanced trading functions.

This page is intended to provide assistance with creating algo orders in the API. For more information on what IB Algorithms can do, please visit our IBKR Order Types and Algos page.

In nearly all cases, Algo orders are additional parameters that can be used in addition to a standing order.

Because of this structure, we will be using our Limit Order sample as a baseline. The algos documented here will be attached to the same “order” variable as used here.

order = Order()
order.action = action
order.orderType = "LMT"
order.totalQuantity = quantity
order.lmtPrice = limitPrice

Order order = new Order();
order.action(action);
order.orderType("LMT");
order.totalQuantity(quantity);
order.lmtPrice(limitPrice);
order.tif(TimeInForce.DAY);

Order order;
order.action = action;
order.orderType = "LMT";
order.totalQuantity = quantity;
order.lmtPrice = limitPrice;

Order order = new Order();
order.Action = action;
order.OrderType = "LMT";
order.TotalQuantity = quantity;
order.LmtPrice = limitPrice;

Dim order As Order = New Order
order.Action = action
order.OrderType = "LMT"
order.TotalQuantity = quantity
order.LmtPrice = limitPrice

IB Algorithms
Copy Location

Accumulate/Distribute
Copy Location

The Accumulate/Distribute algo can help you to achieve the best price for a large volume order without being noticed in the market, and can be set up for high frequency trading. By slicing your order into smaller randomly-sized order increments that are released at random time intervals within a user-defined time period, the algo allows the trading of large blocks of stock and other instruments without being detected in the market. The algo allows limit, market, and relative order types. It is important to keep in mind the API A/D algo will not have all available parameters of the A/D algos that can be created in TWS.

Algo Strategy Value: AD

componentSize: int. Quantity of increment.
Valid Value/Format: Cannot exceed initial size

timeBetweenOrders: int. Time interval in seconds between each order.
Valid Value/Format: 30

randomizeTime20: bool. Randomize time period by +/- 20%.
Valid Value/Format: 1 (true) or 0 (false)

randomizeSize55: bool. Randomize size by +/- 55%.
Valid Value/Format: 1 (true) or 0 (false)

giveUp: int. Stop attempting to catch up to the size value if the conditions are not achieved.

catchUp: bool. Catch up in time.
Valid Value/Format: 1 (true) or 0 (false)

waitForFill: bool. Wait for current order to fill before submitting next order.
Valid Value/Format: 1 (true) or 0 (false)

activeTimeStart: String. Algorithm starting time.
Valid Value/Format: YYYYMMDD-hh:mm:ss TMZ

activeTimeEnd: String. Algorithm ending time.
Valid Value/Format: YYYYMMDD-hh:mm:ss TMZ

order.algoStrategy = "AD"
order.algoParams = []
order.algoParams.append(TagValue("componentSize", componentSize))
order.algoParams.append(TagValue("timeBetweenOrders", timeBetweenOrders))
order.algoParams.append(TagValue("randomizeTime20", int(randomizeTime20)))
order.algoParams.append(TagValue("randomizeSize55", int(randomizeSize55)))
order.algoParams.append(TagValue("giveUp", giveUp))
order.algoParams.append(TagValue("catchUp", int(catchUp)))
order.algoParams.append(TagValue("waitForFill", int(waitForFill)))
order.algoParams.append(TagValue("activeTimeStart", startTime))
order.algoParams.append(TagValue("activeTimeEnd", endTime))

order.algoStrategy("AD");
order.algoParams(new ArrayList());
order.algoParams().add(new TagValue("componentSize", String.valueOf(componentSize)));
order.algoParams().add(new TagValue("timeBetweenOrders", String.valueOf(timeBetweenOrders)));
order.algoParams().add(new TagValue("randomizeTime20", randomizeTime20 ? "1" : "0"));
order.algoParams().add(new TagValue("randomizeSize55", randomizeSize55 ? "1" : "0"));
order.algoParams().add(new TagValue("giveUp", String.valueOf(giveUp)));
order.algoParams().add(new TagValue("catchUp", catchUp ? "1" : "0"));
order.algoParams().add(new TagValue("waitForFill", waitForFill ? "1" : "0"));
order.algoParams().add(new TagValue("activeTimeStart", startTime));
order.algoParams().add(new TagValue("activeTimeEnd", endTime));

order.algoStrategy = "AD";
order.algoParams.reset(new TagValueList());
TagValueSPtr tag1(new TagValue("componentSize", std::to_string(componentSize)));
TagValueSPtr tag2(new TagValue("timeBetweenOrders",std::to_string(timeBetweenOrders)));
TagValueSPtr tag3(new TagValue("randomizeTime20", randomizeTime20 ? "1" : "0"));
TagValueSPtr tag4(new TagValue("randomizeSize55", randomizeSize55 ? "1" : "0"));
TagValueSPtr tag5(new TagValue("giveUp", std::to_string(giveUp)));
TagValueSPtr tag6(new TagValue("catchUp", catchUp ? "1" : "0"));
TagValueSPtr tag7(new TagValue("waitForFill", waitForFill ? "1" : "0"));
TagValueSPtr tag8(new TagValue("activeTimeStart", startTime));
TagValueSPtr tag9(new TagValue("activeTimeEnd", endTime));

order.algoParams->push_back(tag1);
order.algoParams->push_back(tag2);
order.algoParams->push_back(tag3);
order.algoParams->push_back(tag4);
order.algoParams->push_back(tag5);
order.algoParams->push_back(tag6);
order.algoParams->push_back(tag7);
order.algoParams->push_back(tag8);
order.algoParams->push_back(tag9);

order.AlgoStrategy = "AD";
order.AlgoParams = new List();
order.AlgoParams.Add(new TagValue("componentSize", componentSize.ToString()));
order.AlgoParams.Add(new TagValue("timeBetweenOrders", timeBetweenOrders.ToString()));
order.AlgoParams.Add(new TagValue("randomizeTime20", randomizeTime20 ? "1" : "0"));
order.AlgoParams.Add(new TagValue("randomizeSize55", randomizeSize55 ? "1" : "0"));
order.AlgoParams.Add(new TagValue("giveUp", giveUp.ToString()));
order.AlgoParams.Add(new TagValue("catchUp", catchUp ? "1" : "0"));
order.AlgoParams.Add(new TagValue("waitForFill", waitForFill ? "1" : "0"));
order.AlgoParams.Add(new TagValue("activeTimeStart", startTime));
order.AlgoParams.Add(new TagValue("activeTimeEnd", endTime));

order.AlgoStrategy = "AD"
order.AlgoParams = New List(Of TagValue)
order.AlgoParams.Add(New TagValue("componentSize", componentSize.ToString()))
order.AlgoParams.Add(New TagValue("timeBetweenOrders", timeBetweenOrders.ToString()))
order.AlgoParams.Add(New TagValue("randomizeTime20", BooleantoString(randomizeTime20)))
order.AlgoParams.Add(New TagValue("randomizeSize55", BooleantoString(randomizeSize55)))
order.AlgoParams.Add(New TagValue("giveUp", giveUp.ToString()))
order.AlgoParams.Add(New TagValue("catchUp", BooleantoString(catchUp)))
order.AlgoParams.Add(New TagValue("waitForFill", BooleantoString(waitForFill)))
order.AlgoParams.Add(New TagValue("activeTimeStart", startTime))
order.AlgoParams.Add(New TagValue("activeTimeEnd", endTime))

Accumulate/Distribute (Alt.)
Copy Location

The “AccuDistr” variant of the Accumulate/Distribute Algo is conceptually the same as the pre-existing “AD”. However, “AccuDistr” introduces the ability to close existing Trader Workstation sessions while still allowing the algo to continue working. In addition to the underlying behavior change, “AccuDistr” appears visually different while viewed from Trader Workstation, offering a new menu under the “IB ALGO” tab.

It is important to note that “AccuDistr” has removed the ability to use the “giveUp” field. As such, users who require “giveUp” for their strategy MUST continue utilizing the “AD” variant for the Accumulate/Distribute algo.

Algo Strategy Value: AccuDistr