INinteractivebrokers
Alert

Create or modify alert

Please note here, DO NOT pass orderId when creating a new alert, toolId is only required for MTA alert

post/iserver/account/{accountId}/alert

Request

  • Base URL
    http://localhost:5000/v1/api
  • URL
    http://localhost:5000/v1/api/iserver/account/{accountId}/alert
  • Auth
    none declared

Path parameters

accountIdstring required

account id

Request body

orderIdinteger

orderId is required when modifying alert. You can get it from /iserver/account/:accountId/alerts

alertNamestring

name of alert

alertMessagestring

The message you want to receive via email or text message

alertRepeatableinteger

whether alert is repeatable or not, so value can only be 0 or 1, this has to be 1 for MTA alert

emailstring

email address to receive alert

sendMessageinteger

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

expireTimestring

format, YYYYMMDD-HH:mm:ss, please NOTE this will only work when tif is GTD

outsideRthinteger

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

iTWSOrdersOnlyinteger

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

showPopupinteger

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

toolIdinteger

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

playAudiostring

audio message to play when alert is triggered

Example request

{
  "expireTime": "20201105-19:51:14",
  "conditions": [
    {
      "conidex": "8314@SMART",
      "operator": ">=",
      "triggerMethod": "0",
      "value": "220"
    }
  ]
}

Response

returns an object

request_idinteger
order_idinteger
successboolean
textstring
order_statusstring
warning_messagestring

Changes

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