Order Status
The Order Status endpoint may be used to monitor a single specific order while it remains active.
Important Notes:
- For multi-account structures such as Financial Advisors or linked-account structures, users must call /iserver/account to switch to the affiliated account before requesting order status. It is otherwise expected to result in a ‘503’ error.
- If an order has been cancelled or filled prior to the active session and there is no cached information saved, querying the order status endpoint would be expected to result in a ‘503’ error.
Retrieve the given status of an individual order using the orderId returned by the order placement response or the orderId available in the live order response.
Abap
Python
Abap
Response Object
sub_type: null.
Internal use only.
request_id: String.
Returns the requestId of the order palced by the user.
order_id: int.
Returns the orderId of the requested order.
conidex: String.
Returns the contract identifier for the order.
conid: int.
Returns the contract identifier for the order.
symbol: String.
Returns the ticker symbol for the order.
side: String.
Returns the side of the order.
contract_description_1: String.
Returns the local symbol of the order.
listing_exchange: String.
Returns the primary listing exchange of the orer.
option_acct: String.
For Client Portal use (Internal use only).
company_name: String.
Returns the company long name.
size: String.
Remainder of order to be filled
total_size: String.
Total quantity of the order.
currency: String.
Returns the base currency of the order.
account: String.
Returns the account the order was placed for.
order_type: String.
Returns the order type for the given order.
cum_fill: String.
Total filled quantity of the order
order_status: String.
Returns the current status of the order.
order_ccp_status: String.
Returns the current status of the order as a code.
order_status_description: String.
Returns the human readable response of the order status.
tif: String.
Returns the time in force of the order.
fg_color: String.
For Client Portal use (Internal use only).
bg_color: String.
For Client Portal use (Internal use only).
order_not_editable: bool.
Returns whether or not the order can be modified.
This is relevant for orders that are currently or have already been executed.
editable_fields: null.
For Client Portal use (Internal use only).
cannot_cancel_order: bool.
Returns whether or not the order can be cancelled.
This is relevant for orders that are currently or have already been executed.
deactivate_order: bool.
Return whether or not the order has been marked inactive.
sec_type: String.
Returns the security type of the order’s contract.
available_chart_periods: String.
For Client Portal use (Internal use only).
order_description: String.
Returns the description of the order including the side, size, order type, price, and tif.
order_description_with_contract: String.
Returns the description of the order including the side, size, symbol, order type, price, and tif.
alert_active: int.
Returns wheteher or not there is an active alert available on the order.
child_order_type: String.
type of the child order
Value Format: A=attached, B=beta-hedge, 0=No Child
order_clearing_account: String.
Returns the accountID for the submitted order.
size_and_fills: String.
Displays size / cumulative fill
exit_strategy_display_price: String.
Displays the price of the order as it resolved its execution.
exit_strategy_chart_description: String.
Returns the description of the order including the side, size, order type, price, and tif.
average_price: String.
Returns the average price of execution for the order.
exit_strategy_tool_availability: String.
Internal use only.
allowed_duplicate_opposite: bool.
Returns whether or not the opposing order can be placed on the market.
order_time: String.
Returns the datetime of the order placement.
Time returned is based on UTC timezone.
Value Format: YYMMDDHHmmss