Alert

Get details of an alert

Use the endpoint /iserver/account/:accountId/alerts to receive the alert id. The order_id in the response is the alert id.

get/iserver/account/alert/:id

Path parameters

idstring required

alert id

Response

returns an object

accountstring

account id

order_idinteger

alert_namestring

name of alert

alert_messagestring

The message you want to receive via email or text message

alert_activeinteger

whether alert is active or not, so value can only be 0 or 1

alert_repeatableinteger

whether alert is repeatable or not, so value can only be 0 or 1

alert_emailstring

email address to receive alert

alert_send_messageinteger

whether allowing to send email or not, so value can only be 0 or 1,

tifstring

time in force, can only be GTC or GTD

expire_timestring

format, YYYYMMDD-HH:mm:ss

order_statusstring

status of alert

outsideRthinteger

value can only be 0 or 1, set to 1 if the alert can be triggered outside regular trading hours.

itws_orders_onlyinteger

value can only be 0 or 1, set to 1 to enable the alert only in IBKR mobile

alert_show_popupinteger

value can only be 0 or 1, set to 1 to allow to show alert in pop-ups

alert_triggeredboolean

whether the alert has been triggered

order_not_editableboolean

whether the alert can be edited

tool_idinteger

for MTA alert only, each user has a unique toolId and it will stay the same, do not send for normal alert

alert_play_audiostring

audio message to play when alert is triggered

alert_mta_currencystring

MTA alert only

alert_mta_defaultsstring

MTA alert only

time_zonestring

MTA alert only

alert_default_typestring

MTA alert only

condition_sizeinteger

size of conditions array

condition_outside_rthinteger

whether allowing the condition can be triggered outside of regular trading hours, 1 means allow

Example response

{
  "expire_time": "20201105-19:51:14",
  "order_status": "Submitted",
  "conditions": [
    {
      "conidex": "8314@SMART",
      "contract_description_1": "FB Stock (NASDAQ.NMS)",
      "condition_operator": "- >= - <=\n",
      "condition_trigger_method": "0",
      "condition_value": "220"
    }
  ]
}

Changes

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