Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingOrders

Status Of A Single Order

Retrieve the status of a single order. Only displays orders from the current brokerage session. If orders executed on a previous day or session, queries will 503 error.

get/iserver/account/order/status/{orderId}

Path parameters

orderIdstring required

Response

order status

sub_typestring nullable

Internal use only.

request_idstring

Internal use only. IB-assigned identifier for the status request.

server_idstring

IB-assigned meta-identifier used to associate rejected and resubmitted orders following Server Prompts.

order_idinteger

The IB-assigned order identifier of the order, as provided in the request path.

conidexstring

Contract ID and routing destination in format 123456@EXCHANGE.

conidinteger

Contract ID of the order's instrument.

symbolstring

Symbol of the order ticket's instrument.

side'BUY' | 'SELL'

Side of the order ticket.

contract_description_1string

Human-readable description of the order's instrument.

listing_exchangestring

Primary listing exchange of the order ticket's instrument.

option_acctstring

Internal use only.

company_namestring

Name of the company or asset associated with the instrument.

sizestring

Remaining unfilled size of the order ticket. Will reflect 0.0 if order is filled in full, cancelled, or otherwise resolved and no longer working.

total_sizestring

The total size of the order ticket.

currencystring

The currency in which the instrument trades and executions are conducted.

accountstring

The account receiving executions against this order ticket.

order_typestring

The order's IB order type.

cum_fillstring

Cumulative filled quantity of the instrument against the order ticket.

order_status'Inactive' | 'PendingSubmit' | 'PreSubmitted' | 'Submitted' | 'Filled' | 'PendingCancel' | 'Cancelled' | 'WarnState'

Status of the order ticket.

order_ccp_statusstring

IB internal order status.

order_status_descriptionstring

Human-readable rendering of the order's status meant for presentation in UI.

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

Time in force of the order ticket.

fgColorstring

Internal use. IB's UI foreground color in hex.

bgColorstring

Internal use. IB's UI background color in hex.

order_not_editableboolean

Indicates whether the order ticket can be modified.

editable_fieldsstring

Indicates which fields of the order ticket can be modified currently.

cannot_cancel_orderboolean

Indicates whether the order ticket can be cancelled.

deactivate_orderboolean

Indicates whether the order ticket can be deactivated.

sec_type'STK' | 'OPT' | 'FUT' | 'FOP' | 'CASH' | 'CRYPTO' | 'BOND' | 'WAR' | 'FUND'

IB asset class identifier.

available_chart_periodsstring

Internal use. Indicates chart periods available for the instrument.

order_descriptionstring

Human-readable description of the status or current result of the order ticket, meant for UI presentation.

order_description_with_contractstring

Human-readable description of the status or current result of the order ticket, meant for UI presentation. Includes instrument name.

alert_active'0' | '1'

Indicates that an alert is active for the order ticket.

child_order_type'0' | 'A' | 'B'

Indicates if the order ticket is hedged, and if so, in what way. 0 = No hedge, A = Attached child hedge order, B = Beta/portfolio hedge

order_clearing_accountstring

The IB account to which the order ticket clears.

size_and_fillsstring

A string reflecting the cumulative fills and total size of the order.

exit_strategy_display_pricestring

Internal use. The UI-displayed price associated with a Client Portal exist strategy.

exit_strategy_chart_descriptionstring

Internal use. A string describing an active Client Portal exit strategy, or the result of its execution.

average_pricestring

Average price of fills against the order, if any.

exit_strategy_tool_availabilitystring

Internal use. Indicates the availability of Client Portal exit strategy tool for the order.

allowed_duplicate_oppositeboolean

Indicates whether an identical order on the opposite side can be placed.

order_timestring

Time of the order's submission in format YYMMDDhhmmss.