Sign in
Order

Order Status

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

Path parameters

orderIdstring required

Customer order id, use /iservers/account/orders endpoint to query orderId.

Response

returns an object

sub_typestring

order sub-type

request_idstring

order request id

order_idinteger

system generated order id, unique per account

conidexstring

conid and exchange. Format supports conid or conid@exchange

symbolstring

Underlying symbol

side'B' | 'S' | 'X'

The side of the market of the order.

  • B - Buy contract near posted ask price
  • S - Sell contract near posted bid price
  • X - Option expired
contract_description_1string

Format contract name

listing_exchangestring

Trading Exchange or Venue

option_acctstring
company_namestring

Contracts company name

sizestring

Quantity updated

total_sizestring

Total quantity

currencystring

Contract traded currency

accountstring

account id

order_typestring

Types of orders

limit_pricestring

Limit price

stop_pricestring

Stop price

cum_fillstring

Cumulative fill

order_statusstring
  • PendingSubmit - Indicates the order was sent, but confirmation has not been received that it has been received by the destination. Occurs most commonly if an exchange is closed.
  • PendingCancel - Indicates that a request has been sent to cancel an order but confirmation has not been received of its cancellation. * PreSubmitted - Indicates that a simulated order type has been accepted by the IBKR system and that this order has yet to be elected. The order is held in the IBKR system until the election criteria are met. At that time the order is transmitted to the order destination as specified.
  • Submitted - Indicates that the order has been accepted at the order destination and is working. * Cancelled - Indicates that the balance of the order has been confirmed cancelled by the IB system. This could occur unexpectedly when IB or the destination has rejected the order.
  • Filled - Indicates that the order has been completely filled. * Inactive - Indicates the order is not working, for instance if the order was invalid and triggered an error message, or if the order was to short a security and shares have not yet been located.
order_status_descriptionstring

Description of the order status

tifstring

Time-in-Force - length of time order will continue working before it is canceled.

fg_colorstring

Foreground color in hex format

bg_colorstring

Background color in hex format

order_not_editableboolean

If true not allowed to modify order

editable_fieldsstring

Fields that can be edited in escaped unicode characters

cannot_cancel_orderboolean

If true not allowed to cancel order

outside_rthboolean

If true order trades outside regular trading hours

deactivate_orderboolean

If true order is de-activated

use_price_mgmt_algoboolean

If true price management algo is enabled, refer to https://www.interactivebrokers.com/en/index.php?f=43423

sec_typestring

Asset class

available_chart_periodsstring

List of available chart periods

order_descriptionstring

Format description of order

order_description_with_contractstring

order_description with the symbol

alert_activeinteger
child_order_typestring

type of the child order

size_and_fillsstring

Format fillQuantity\totalQuantity

exit_strategy_display_pricestring

Position display price

exit_strategy_chart_descriptionstring

Position description to display on chart

exit_strategy_tool_availabilitystring
  • 1: If your account has position or order for contract * 0: If your account has no position or order for contract
allowed_duplicate_oppositeboolean

Returns true if contract supports duplicate/opposite side order.

order_timestring

Time of status update in unix time

oca_group_idstring

only exists for oca orders, oca orders in same group will have same id

Example response

{
  "contract_description_1": "FB Stock (NASDAQ.NMS)",
  "listing_exchange": "NASDAQ.NMS",
  "company_name": "APPLE INC",
  "order_type": "LIMIT",
  "editable_fields": "\\u001E",
  "sec_type": "STK",
  "order_description": "BUY 100 LIMIT 125.0 DAY",
  "order_description_with_contract": "BUY 100 AAPL LIMIT 125.0 DAY",
  "child_order_type": "A=attached, B=beta-hedge, etc",
  "size_and_fills": "0/9"
}

Changes

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