Skip to content
Stock Connect

List Stock Connect constituents

Returns a page of constituents and their indicator values by category, sort indicator, and date, for the constituent ranking in Stock Connect. Request again when the category, sort, date, or page changes.

Each list[].indicators value matches the indicators of the current second-level category in order; display it by the format and color of that indicator. For percentage indicators, the Broker App appends % to the value directly. Fewer items than limit means there is no more data. On the first page (offset is 0), dt lists the dates available for the first-level category and can drive a date picker.

GEThttps://api.lbkrs.com/v1/stock-info/constituent-stock-list

Parameters

first_categorystringqueryRequired

First-level category key

sec_categorystringqueryRequired

Second-level category key

indicatorstringqueryRequired

Sort indicator key

orderstringqueryRequired

Sort order:

  • asc - Ascending
  • desc - Descending

ascdesc

dtstringquery

Data date from dt in an earlier response. Omit it to get data for the latest date

limitintegerqueryRequired

Page size. The Broker App passes 20

offsetintegerqueryRequired

Pagination offset starting from 0. Pass the number of loaded items

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Stock Connect constituents” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Constituents on the current page

Child attributes
counter_idstring

Security ID

namestring

Security name

indicatorsarray<string>

Indicator values in the same order as the indicators of the current second-level category

dtarray<string>

Available dates, returned on the first page only

Whale Docs