Skip to content
Market Home Modules

Get popular rankings module

Returns the rankings for the Rankings module on the market home page. Each ranking lists its top securities grouped by market, with extended-session prices, so the Broker App can show a ranking summary and link to the full ranking.

Also used for the popular rankings shown on the search page before the Client enters a keyword.

GEThttps://api.lbkrs.com/v2/newmarket/show_lbrank

Parameters

rank_typestringquery

Ranking type. The market home page and the search page both pass 0

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get popular rankings module” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
itemsarray<object>

Rankings

Child attributes
keystring

Ranking key, used to identify the ranking and open the full ranking

namestring

Ranking name

rank_typeinteger

Ranking type

updated_atstring

Time the ranking was last updated

descstring

Ranking description

ranklistsarray<object>

Ranked securities grouped by market

Child attributes
marketstring

Market code, such as US or HK

detailsarray<object>

Ranked securities in this market, in rank order

Child attributes
counter_idstring

Security counter_id

namestring

Security name

last_donestring

Last price

prev_closestring

Previous close

chgstring

Price change ratio as a decimal, such as 0.0123 for 1.23%

extend_stateinteger

Extended-session state:

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

Latest extended-session price. Valid when extend_state is not 0

extend_chgstring

Extended-session price change ratio as a decimal

delayboolean

Whether the quote is delayed

Whale Docs