Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingAlerts

Details Of A Specific Alert

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

get/iserver/account/alert/{alertId}

Path parameters

alertIdinteger required

Query parameters

type'Q' required

queryType

Response

An object containing all unique details of the specified alert.

accountstring

Requestor's account ID

order_idinteger

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_active'1' | '0'

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

alert_repeatableinteger

Returns if the alert can be sent more than once.

alert_emailstring

Returns the designated email address for sendMessage functionality.

alert_send_messageinteger

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_popupinteger

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

alert_play_audiointeger

Returns whether or not the alert will play audio

order_status'Presubmitted' | 'Submitted'

represent order statusAlways returns "Presubmitted".

alert_triggeredinteger

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_onlyinteger

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_idinteger

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

time_zonestring

Returned for time-specific conditions.

alert_default_typeinteger

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

condition_sizeinteger

Returns the total number of conditions in the alert.

condition_outside_rthinteger

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