Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingAlerts

Create Or Modify Alert

Endpoint used to create a new alert, or modify an existing alert.

post/iserver/account/{accountId}/alert

Path parameters

accountIdstring required

Request body

orderIdinteger

optional; used in case of modification and represent Alert Id

alertNamestring required

Alert name.

alertMessagestring required

Alert message which will be sent

alertRepeatable'0' | '1' required

Boolean number (0, 1) signifies if an alert can be triggered more than once. A value of '1' is required for MTA alerts

emailstring

Email address you want to send email alerts to

expireTimestring

Used with a tif of "GTD" only. Signifies time when the alert should terminate if no alert is triggered.

iTWSOrdersOnlyinteger

allow (0) or disallow (1) alerts to trigger alerts through the mobile app

outsideRth'0' | '1' required

Allow (1) or disallow (0) the alert to be triggered outside of regular trading hours

sendMessage'0' | '1'

allow (1) or disallow (0) alerts to trigger email messages

showPopupinteger

allow (1) or disallow (0) alerts to trigger TWS Pop-up messages

tif'GTC' | 'GTD' required

Time in Force duration of alert.

Response

An object containing valid accounts and the account properties regarding trading access. This endpoint is also used to confirm account validation.

request_idinteger

Not applicable

order_idinteger

The tracking number of the alert. Alert identifier internally referenced as order id.

successboolean

Displays result status of alert request

textstring

Response message to clarify submission status.

order_statusstring

Not applicable

warning_messagestring

Returns 'null'