Skip to content
ETFs and Topics

List ETFs related to an index

Returns a page of ETFs that track the specified index, with the requested indicator values, for the Related ETFs list on an index detail page. Request again when the sort order or page changes.

The values of indicators and the default sort come from the ranking indicator configuration (GET /newmarket/rank/indicator/config with scene set to index_etf). Each list[].indicators value matches the requested indicators in order. Stop paginating when the loaded count reaches total.

POSThttps://api.lbkrs.com/newmarket/index/etf/list

Request body application/json

index_counter_idstringrequired

Index security ID

indicatorsarray<string>required

Indicator keys to return, in column order

sort_indicatorstringrequired

Sort indicator key. Defaults to chg

orderintegerrequired

Sort order:

  • 1 - Descending
  • 0 - Ascending
Values
0
1
offsetintegerrequired

Pagination offset, starting from 0

limitintegerrequired

Page size

Responses

HTTP 200The request succeeded. The response body contains the result of the “List ETFs related to an index” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total number of matching ETFs

listarray<object>

ETFs on the current page

Child attributes
counter_idstring

Security ID, such as ST/HK/2800

namestring

Security name

codestring

Ticker code

marketstring

Market, such as HK or US

last_donestring

Last price

prev_closestring

Previous close

chgstring

Price change rate as a decimal ratio

indicatorsarray<string>

Indicator values in the same order as the requested indicators. Format them by the format of the indicator configuration

extend_stateinteger

Current extended trading session, which decides whether to show extend_price and extend_chg:

  • 0 - Regular session
  • 1 - Pre-market
  • 2 - After-hours
  • 3 - Overnight
Values
0
1
2
3
extend_pricestring

Last price in the extended session

extend_chgstring

Price change rate in the extended session as a decimal ratio

Whale Docs