Details Of A Specific Alert

GET

/iserver/account/alert/:alertId

GET

/v1/api/iserver/account/alert/:alertId

$ curl -G https://api.ibkr.com/v1/api/iserver/account/alert/1 \
>      -d type=Q

1 {
2   "account": "U1234567",
3   "order_id": 833967258,
4   "tif": "GTC",
5   "alert_active": 1,
6   "alert_repeatable": 0,
7   "alert_email": "john.smith@example.com",
8   "alert_send_message": 1,
9   "alert_message": "alert message",
10   "alert_show_popup": 1,
11   "order_status": "Submitted",
12   "alert_triggered": 1,
13   "fg_color": "#FFFFFF",
14   "bg_color": "#0000CC",
15   "order_not_editable": false,
16   "itws_orders_only": 0,
17   "condition_size": 1,
18   "condition_outside_rth": 1,
19   "conditions": [
20     {
21       "condition_type": 1,
22       "conidex": "8314@NYSE",
23       "contract_description_1": "IBM",
24       "condition_operator": ">=",
25       "condition_trigger_method": 0,
26       "condition_value": "500.00",
27       "condition_logic_bind": true
28     }
29   ],
30   "alert_name": "IBM"
31 }

Request details of a specific alert by providing the assigned alertId Id.

Path parameters

alertIdlongRequired

Query parameters

typeenumRequired

queryType

Allowed values:

Response

An object containing all unique details of the specified alert.

accountstring

Requestor's account ID

order_idlong

Alert's tracking ID. Can be used for modifying or deleting alerts.

alertNamestring

Human readable name of the alert.

tifstring

Time in Force effective for the Alert

expire_timestring

Returns the UTC formatted date used in GTD orders.

alert_activeenum

Returns if the alert is active [1] or disabled [0].

alert_repeatablelong

Returns if the alert can be sent more than once.

alert_emailstring

Returns the designated email address for sendMessage functionality.

alert_send_messagelong

Returns whether or not the alert will send an email.

alert_messagestring

Returns the body content of what your alert will report once triggered

alert_show_popuplong

Returns whether or not the alert will trigger TWS Pop-up messages

alert_play_audiolong

Returns whether or not the alert will play audio

order_statusenum

represent order statusAlways returns "Presubmitted".

alert_triggeredlong

Returns whether or not the alert was triggered yet.

fg_colorstring

Foreground color. Not applicable to API.

bg_colorstring

Background color. Not applicable to API.

order_not_editableboolean

Returns if the order can be edited.

itws_orders_onlylong

Returns whether or not the alert will trigger mobile notifications.

alert_mta_currencystring

Returns currency set for MTA alerts. Only valid for alert type 8 & 9.

alert_mta_defaultsstring

Returns current MTA default values.

tool_idlong

Tracking ID for MTA alerts only. Returns 'null' for standard alerts.

time_zonestring

Returned for time-specific conditions.

alert_default_typelong

Returns default type set for alerts. Configured in Client Portal.

condition_sizelong

Returns the total number of conditions in the alert.

condition_outside_rthlong

Returns whether or not the alert will trigger outside of regular trading hours.

conditionslist of objects

Returns all conditions

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error