Skip to content
Watchlist

Get all watchlist groups

Returns all watchlist groups of the Client (system and custom), all watchlist securities, pinned securities, and the watchlist limit, for rendering groups and securities on the watchlist page. It is also used to mark watched securities in news lists and to show the Add to watchlist button state on news and community pages. Use name to identify a group and show_name to display it. This operation only reads data and has no side effects.

WhaleCore's watchlistService() provides the corresponding capability: after you call refresh(sub:), groups and stocks are delivered through the onWatchlistUpdated callback. If you use WhaleCore, prefer watchlistService().

GEThttps://api.lbkrs.com/v7/watchlist/groups/all

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get all watchlist groups” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Watchlist groups and all watchlist securities

allarray<object>

All groups, system and custom

Child attributes
idstring

Group ID. Put it in groups when adding or removing watchlist stocks

namestring

Stable group identifier (system groups such as all and holdings). Use it to identify the group, not for display

show_namestring

Display name, possibly localized. Fall back to name when empty

kindinteger

Group kind, distinguishing system groups from custom groups

counter_idsarray<string>

Security IDs (counter_id) in the group, in group order

hiddenboolean

Whether the Client has hidden the group

indexstring

Group sort value

allstocksarray<object>

All watchlist securities, deduplicated, with the time added

Child attributes
counter_idstring

Security ID (counter_id)

codestring

Security code

namestring

Security name

marketstring

Market code, such as US or HK

quoteInfoobject
Child attributes
watched_atinteger

Time the security was added, as a Unix timestamp in seconds

maxinteger

Maximum number of watchlist securities

timestampstring

Version timestamp of the watchlist data

tied_stocksarray<string>

Pinned security IDs (counter_id), in pinned order

Whale Docs