Skip to content
Stock Connect

Get Stock Connect constituent categories

Returns the first-level categories, second-level categories, indicator columns, and default sort of the constituent ranking for the specified direction, for the category switcher and table header of the constituent section in Stock Connect.

After you get the categories, request GET /v1/stock-info/constituent-stock-list with the selected first_categories[].key, sec_categories[].key, and indicator key.

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

Parameters

trading_typestringqueryRequired

Flow direction:

  • southbound - Southbound (Hong Kong Stock Connect)
  • northbound - Northbound (Shanghai and Shenzhen Connect)

southboundnorthbound

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Stock Connect constituent categories” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
first_categoriesarray<object>

First-level categories

Child attributes
keystring

First-level category key. Pass it as first_category to the list operation

namestring

First-level category name

sec_categoriesarray<object>

Second-level categories

Child attributes
keystring

Second-level category key. Pass it as sec_category to the list operation

namestring

Second-level category name

indicatorsarray<object>

Indicator columns of the category, in the same order as the indicators returned by the list operation

Child attributes
keystring

Indicator key. Pass it as indicator to the list operation

namestring

Indicator name, used as the column heading

is_sortboolean

Whether the ranking can be sorted by this indicator

formatstring

Value format:

  • percent - Percentage
  • percent_signed - Signed percentage
  • big - Large number abbreviated with units
  • raw - Show as is
colorstring

Color rule:

  • volatile - Use rise and fall colors by sign
  • regular - Use the regular text color
master_indicatorstring

Default sort indicator key

default_orderstring

Default sort order:

  • asc - Ascending
  • desc - Descending
Values
asc
desc
Whale Docs