latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingOrders

Modify Open Order

Modify an existing, unfilled order.

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

Path parameters

accountIdstring required

The account to which the order will clear.

orderIdstring required

The IB-assigned order ID of the desired order ticket.

Request body

acctIdstring

Receiving account of the order ticket.

conidinteger required

IB contract ID of the instrument.

conidexstring

Contract ID and routing destination together in format 123456@EXCHANGE.

secTypestring

IB asset class identifier.

cOIDstring

Client-configurable order identifier. The value must be unique for a 24 hour span. The value can be no longer than 64 characters. Should not be set for the child of a bracket order.

parentIdstring

If the order ticket is a child order in a bracket, the parentId field must be set equal to the cOID provided for the parent order.

listingExchangestring

The listing exchange of the instrument.

isSingleGroupboolean

Indicates that all orders in the containing array are to be treated as an OCA group.

outsideRTHboolean

Instructs IB to permit the order to execute outside of regular trading hours.

allOrNoneboolean

Instructs IB to execute the order entirely or not execute at all.

auxPricenumber double

Additional price value used in certain order types, such as stop orders.

tickerstring

Ticker symbol of the instrument.

trailingAmtnumber double

Offset used with Trailing orders.

trailingType'amt' | '%'

Specifies the type of trailing used with a Trailing order.

referrerstring

IB internal identifier for order entry UI element.

cashQtynumber double

Quantity of currency used with cash quantity orders.

useAdaptiveboolean

Instructs IB to apply the Price Management Algo.

isCcyConvboolean

Indicates that a forex order is for currency conversion and should not entail a virtual forex position in the account, where applicable.

orderTypestring required

IB order type identifier.

pricenumber double

Price of the order ticket, where applicable.

side'BUY' | 'SELL' required

Side of the order ticket.

tif'DAY' | 'IOC' | 'GTC' | 'OPG' | 'PAX' required

Time in force of the order ticket.

quantitynumber double required

Quantity of the order ticket in units of the instrument.

strategystring

The name of an execution algorithm.

extOperatorstring

ExtOperator is used to identify external operator

manualIndicatorboolean

For all orders for US Futures products, clients must submit this flag to indicate whether the order was originated manually (by a natural person) or automatically (by an automated trading system transmitting orders without human intervention). Submit a True value to indicate a manually originated order, and submit a False value to indicate an automated order. Orders for USFUT products that do not include this field will be rejected.

taxOptimizerIdstring

Identifies set of tax lots selected, for gains and losses management.

Response

Status of submission

OR
OR
OR