Details Of A Mobile Trading Alert

GET

/iserver/account/mta

GET

/iserver/account/mta

$ curl https://api.ibkr.com/iserver/account/mta

200mta-details

1 {
2   "account": "U1234567",
3   "order_id": 167426254,
4   "tif": "GTC",
5   "alert_active": 1,
6   "alert_repeatable": 1,
7   "alert_email": "jonh.smith@example.com",
8   "alert_send_message": 1,
9   "alert_show_popup": 0,
10   "order_status": "Submitted",
11   "alert_triggered": 1,
12   "fg_color": "#FFFFFF",
13   "bg_color": "#0000CC",
14   "order_not_editable": false,
15   "itws_orders_only": 0,
16   "alert_mta_currency": "USD",
17   "alert_mta_defaults": "9:STATE=1,MIN=-260000,MAX=260000,STEP=500,DEF_MIN=-26000,DEF_MAX=26000|8:STATE=0,MIN=-15,MAX=15,STEP=0.5,DEF_MIN=-2,DEF_MAX=2|7:STATE=1,MIN=-5,MAX=5,STEP=0.5,DEF_MIN=-2,DEF_MAX=2|4:STATE=1,MIN=1,MAX=50,STEP=1,DEF_VAL=10|5:STATE=0",
18   "tool_id": 55834574848,
19   "time_zone": "all timezones can be here",
20   "condition_size": 1,
21   "condition_outside_rth": 0,
22   "conditions": [
23     {
24       "condition_type": 5,
25       "conidex": "*@*",
26       "contract_description_1": "Unknown",
27       "condition_value": "*",
28       "condition_logic_bind": true
29     }
30   ],
31   "alert_name": "MTA (AutoAlert)"
32 }

Retrieve information about your MTA alert. Each login user only has one mobile trading assistant (MTA) alert with it’s own unique tool id that cannot be changed. MTA alerts can not be created or deleted, only modified. When modified a new order Id is generated.

Response

The alert description for the unique MTA alert on the account.

accountstringOptional

Requestor's account ID

order_idlongOptional

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

alertNamestringOptional

Human readable name of the alert.

tifstringOptional

Time in Force effective for the Alert

expire_timestringOptional

Returns the UTC formatted date used in GTD orders.

alert_activeenumOptional

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

alert_repeatablelongOptional

Returns if the alert can be sent more than once.

alert_emailstringOptional

Returns the designated email address for sendMessage functionality.

alert_send_messagelongOptional

Returns whether or not the alert will send an email.

alert_messagestringOptional

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

alert_show_popuplongOptional

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

alert_play_audiolongOptional

Returns whether or not the alert will play audio

order_statusenumOptional

represent order statusAlways returns "Presubmitted".

alert_triggeredlongOptional

Returns whether or not the alert was triggered yet.

fg_colorstringOptional

Foreground color. Not applicable to API.

bg_colorstringOptional

Background color. Not applicable to API.

order_not_editablebooleanOptional

Returns if the order can be edited.

itws_orders_onlylongOptional

Returns whether or not the alert will trigger mobile notifications.

alert_mta_currencystringOptional

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

alert_mta_defaultsstringOptional

Returns current MTA default values.

tool_idlongOptional

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

time_zonestringOptional

Returned for time-specific conditions.

alert_default_typelongOptional

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

condition_sizelongOptional

Returns the total number of conditions in the alert.

condition_outside_rthlongOptional

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

conditionslist of objectsOptional

Returns all conditions