v1

latestSwagger 2.02026-07-1316446.5 KB
Orders

Place Order

Places order

post/accounts/{account}/orders

Request body

CustomerOrderIdstring

The order ID assigned by the customer.

Tickerstring

The symbol that identifies the trading product

ListingExchangestring

The exchange on which the trading product is listed (only for InstrumentType=STK)

Currencystring

The currency in which the FX pair trades (only for InstrumentType=CASH)

InstrumentTypestring

The instrument type of the contract

ContractIdnumber

The internal IB identifier for the trading product specified as an integer (can be obtained in response to /secdef request)

Quantitynumber

The number of units in the order; contracts or shares

Pricenumber

The order price

Order Type1 | 2 | 3 | 4

Market = '1' Limit = '2' Stop = '3' StopLimit = '4'

Aux Pricenumber

Required Price to support Stop and Stop Limit orders

Time in Force0 | 1 | 2 | 3 | 7

Defines order's active lifetime. Day = '0' GTC (Good till Cancel) = '1' IOC (Immediate or Cancel) = '3' Open = '2' Close = '7'

Outside RTHnumber

Indicates if order is active outside regular trading hours, where defined. 0 = no (default), 1 = yes

Side1 | 2

Buy = '1', Sell = '2'

OrderRestrictionsnumber

MultiValueString representing the restrictions associated with an order. If more than one restriction is applicable to an order, this field can contain multiple instructions separated by space. '1' Program Trade '2' Index Arbitrage '3' Non-Index Arbitrage

GermanHftAlgoboolean

By setting this bool to false the customer attests that the order is not subject to German HFT Act, was not generated using any automated algorithm, and no algorithm determined or changed financial instrument, side, quantity, order type, limit or other price, trading venue or timing of this order. Currently we cannot accept orders where this flag is set to true. Such orders will be rejected.

Mifid2DecisionMakerstring

This field permits specification of the user's preregistered (via account management) MiFID II short code for decision makers.

Mifid2Algostring

This field permits specification of the user's preregistered (via account management) MiFID II short code for algos that are responsible for investment decisions

Mifid2ExecutionTraderstring

This field permits specification of the user's preregistered (via account management) MiFID II person responsible for handling/routing of the order

Mifid2ExecutionAlgostring

This field permits specification of the user's preregistered (via account management) MiFID II short code for algos that are responsible for handling/routing of the order.

Response

Returns order status information

CustomerOrderIdnumber
ContractIdnumber
Tickerstring
ListingExchangestring
RemainingQuantitynumber
FilledQuantitynumber
OrderType1 | 2 | 3 | 4

Market = '1' Limit = '2' Stop = '3' StopLimit = '4'

TimeInForce0 | 1 | 2 | 3 | 7

Defines order's active lifetime. Day = '0' GTC (Good till Cancel) = '1' IOC (Immediate or Cancel) = '3' Open = '2' Close = '7'

OutsideRTHstring
Sidestring
Pricenumber
Status'-1' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'A' | 'B' | 'C' | 'D' | 'E'

Status of the order InvalidOrderStatus = '-1' New = '0' PartiallyFilled = '1' Filled = '2' DoneForTheDay = '3' Canceled = '4' Replaced = '5' PendingCancelReplace = '6' Stopped = '7' Rejected = '8' Suspended = '9' PendingNew = 'A' Calculated = 'B' Expired = 'C' AcceptedForBidding = 'D' PendingReplace = 'E'

Warningstring
TransactionTimestring