Skip to content
Price Alerts

Get Indicator Alerts

Returns the Client's indicator alerts grouped by security, with the latest quote of each security, for the security alert, all alerts, and global alert pages:

  • With counter_id: returns only that security's alerts
  • With an empty counter_id and no tpl: returns security alerts for all securities; the Broker App can show them in tabs by market
  • With tpl set to 1: returns global alerts

The id in the list is used to enable or disable an alert (POST /v1/indicator/notify/setnotify) and to delete it (POST /v1/indicator/notify/deletenotify).

POSThttps://api.lbkrs.com/v2/indicator/notify/getnotify

Request body application/json

counter_idstring

Security ID (counter_id). Pass an empty string to query all securities or global alerts

tplinteger

Pass 1 to query global alerts; omit for security alerts

Values
1

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get indicator alerts” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listsarray<object>

Alerts grouped by security

Child attributes
counter_idstring

Security ID (counter_id), such as ST/US/AAPL

codestring

Security symbol

namestring

Security name

marketstring

Market code; OP for options

productstring

Instrument type: 0 stock, 1 option

pricestring

Last price

chgstring

Price change

p_chgstring

Percentage change

indicatorsarray<object>

Indicator alerts of the security

Child attributes
textstring

Display text of the alert condition, such as "Price above 200.00"

enabledboolean

Whether the alert is enabled

frequencyinteger

Alert frequency:

  • 1 - Once per day (alerts on the first trigger of each trading day)
  • 2 - Every time (alerts on every trigger, at most once every 5 minutes)
  • 3 - Once only
Values
1
2
3
scopeinteger

Scope of a global alert, only set for global alerts:

  • 1 - Securities in positions
  • 2 - Securities in the watchlist
value_mapobject

Indicator parameters. Keys are the req_key values returned by POST /v1/indicator/notify/getconfig/detail; values are what the Client entered or selected

idstring

Alert ID

indicator_idstring

Alert indicator ID

Whale Docs