Alert

Get a list of available alerts

The response will contain both active and inactive alerts, but it won't have MTA alert

get/iserver/account/:accountId/alerts

Request

Base URL
http://localhost:5000/v1/api
Auth
none declared
TypeScript
https://skmtc.dev/ibkr/apis/client-portal-web-api/docs/iserver/account/:accountId/alerts/get.ts
A function with typed inputs. Its response is checked against the schema.

accountIdstring required

account id

returns an array of objects

order_idinteger

accountstring

account id

alert_namestring

alert_activeinteger

Value can only be 0 or 1, 1 means active

order_timestring

format, YYYYMMDD-HH:mm:ss, the time when you created the alert

alert_triggeredboolean

whether the alert has been triggered or not

alert_repeatableinteger

whether the alert can be repeatable or not, value can be 1 or 0. 1 means true

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