IBibkr
Order

Preview Order (Deprecated)

This end-point is going to be deprecated, you can use /iserver/account/{accountId}/orders/whatif, just pass one order in the array, the order structure will be same. This endpoint allows you to preview order without actually submitting the order and you can get commission information in the response.

post/iserver/account/{accountId}/order/whatif

Request

Path parameters

accountIdstring required

account id

Request body

acctIdstring

acctId is optional. It should be one of the accounts returned by /iserver/accounts. If not passed, the first one in the list is selected.

conidinteger

conid is the identifier of the security you want to trade, you can find the conid with /iserver/secdef/search.

conidexstring

Conid and Exchange - Can be used instead of conid when specifying the contract identifier of a security.

secTypestring

The contract-identifier (conid) and security type (type) specified as a concatenated value, conid:type

cOIDstring

Customer Order ID. An arbitrary string that can be used to identify the order, e.g "my-fb-order". The value must be unique for a 24h span. Please do not set this value for child orders when placing a bracket order.

parentIdstring

Only specify for child orders when placing bracket orders. The parentId for the child order(s) must be equal to the cOId (customer order id) of the parent.

orderTypestring

The order-type determines what type of order you want to send.

  • LMT - A limit order is an order to buy or sell at the specified price or better.
  • MKT - A market order is an order to buy or sell at the markets current NBBO.
  • STP - A stop order becomes a market order once the specified stop price is attained or penetrated.
  • STOP_LIMIT - A stop limit order becomes a limit order once the specified stop price is attained or penetrated.
  • MIDPRICE - A MidPrice order attempts to fill at the current midpoint of the NBBO or better.
  • TRAIL - A sell trailing stop order sets the stop price at a fixed amount below the market price with an attached "trailing" amount. See more details here: https://ndcdyn.interactivebrokers.com/en/index.php?f=605
  • TRAILLMT - 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. See more details here: https://ndcdyn.interactivebrokers.com/en/index.php?f=606
listingExchangestring

listingExchange is optional. By default we use "SMART" routing. Possible values are available via the endpoint: /iserver/contract/{conid}/info, see valid_exchange e.g: SMART,AMEX,NYSE,CBOE,ISE,CHX,ARCA,ISLAND,DRCTEDGE,BEX,BATS,EDGEA,CSFBALGO,JE FFALGO,BYX,IEX,FOXRIVER,TPLUS1,NYSENAT,PSX

isSingleGroupboolean

set to true if you want to place a single group orders(OCA)

outsideRTHboolean

set to true if the order can be executed outside regular trading hours.

pricenumber

optional if order is LMT, or STOP_LIMIT, this is the limit price. For STP|TRAIL this is the stop price. For MIDPRICE this is the option price cap.

auxPriceunknown
sidestring

SELL or BUY

tickerstring

This is the underlying symbol for the contract.

tifstring

The Time-In-Force determines how long the order remains active on the market.

  • GTC - use Good-Till-Cancel for orders to remain active until it executes or cancelled.
  • OPG - use Open-Price-Guarantee for Limit-On-Open (LOO) or Market-On-Open (MOO) orders.
  • DAY - if not executed a Day order will automatically cancel at the end of the markets regular trading hours.
  • IOC - any portion of an Immediate-or-Cancel order that is not filled as soon as it becomes available in the market is cancelled.
trailingAmtnumber

optional if order is TRAIL, or TRAILLMT. When trailingType is amt, this is the trailing amount, when trailingType is %, it means percentage. You must specify both trailingType and trailingAmt for TRAIL and TRAILLMT order

trailingTypestring

This is the trailing type for trailing amount. We only support two types here: amt or %. You must specify both trailingType and trailingAmt for TRAIL and TRAILLMT order

referrerstring

Custom order reference

quantitynumber

Usually integer, for some special cases such as fractional orders can specify as a float, e.g. quantity = 0.001. In some special cases quantity is not specified, such as when using 'cashQty' or 'fxQty'.

cashQtynumber

Cash Quantity - used to specify the monetary value of an order instead of the number of shares. When using 'cashQty' don't specify 'quantity' Orders that express size using a monetary value, e.g. cash quantity can result in fractional shares and are provided on a non-guaranteed basis. The system simulates the order by canceling it once the specified amount is spent (for buy orders) or collected (for sell orders). In addition to the monetary value, the order uses a maximum size that is calculated using the Cash Quantity Estimated Factor, which can be modified in Order Presets.

fxQtynumber

double number, this is the cash quantity field which can only be used for Currency Conversion Orders. When using 'fxQty' don't specify 'quantity'.

useAdaptiveboolean

If true, the system will use the Price Management Algo to submit the order. https://www.interactivebrokers.com/en/index.php?f=43423

isCcyConvboolean

set to true if the order is a FX conversion order

allocationMethodstring

Set the allocation method when placing an order using an FA account for a group Possible allocation methods are "NetLiquidity", "AvailableEquity", "EqualQuantity" and "PctChange".

strategystring

Specify which IB Algo algorithm to use for this order.

strategyParametersobject

The IB Algo parameters for the specified algorithm.

Example request

{
  "conidex": "conidex = 265598",
  "secType": "secType = 265598:STK",
  "trailingType": "amt",
  "referrer": "QuickTrade"
}

Response

returns an object

warnstring
errorstring

Changes

No recorded changes to this operation across all 1 revision of this API.