Skip to content
Market Rankings

Get Ranking Securities

Lists securities in a ranking by first-level category, second-level ranking, and sort indicator, with page support. Returns indicator values, a price snapshot, US extended-session prices, and mini intraday chart data. Use it when switching rankings, sorting by a column, or loading more on the market ranking page, and to show the top entries in the ranking module on the market home page.

Paginate with offset and limit; fewer than limit items means there is no more data. Rankings can change between pages, so deduplicate by counter_id.

GEThttps://api.lbkrs.com/v1/newmarket/revision/rank/list

Parameters

marketstringqueryRequired

Market code:

  • US - US stocks
  • HK - Hong Kong stocks
  • CN - China A-shares
  • SG - Singapore stocks

USHKCNSG

first_categorystringqueryRequired

First-level category key, from first_categories[].key in Get Ranking Configuration

sec_categorystringqueryRequired

Second-level ranking key, from sec_categories[].key

indicatorstringqueryRequired

Sort indicator key; use master_indicator of the second-level ranking by default

orderstringqueryRequired

Sort direction:

  • desc - Descending
  • asc - Ascending

descasc

offsetintegerqueryRequired

Page offset starting at 0; when loading more, pass the number of items already loaded

limitintegerqueryRequired

Number of items per page

filter_penny_stockbooleanqueryRequired

Whether to filter out penny stocks; takes effect only when filter_penny_stock of the second-level ranking is true

scenestringqueryRequired

Usage scene, matching scene in Get Ranking Configuration:

  • index - Ranking module on the market home page
  • extra - Ranking detail page

indexextra

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Ranking Securities” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total number of securities in the ranking

marketstring

Market code

delayboolean

Whether the quotes are delayed; when true, tell the user that prices are delayed

listarray<object>

Ranked securities, ordered by the sort indicator

Child attributes
counter_idstring

Security ID

namestring

Security name

codestring

Ticker symbol, for example AAPL

marketstring

Market, for example US

indicatorsarray<string>

Values of the indicator columns, in the same order as indicators in the ranking configuration; format each value by the format of its indicator

last_donestring

Last price

prev_closestring

Previous close, used as the baseline of the mini intraday chart

chgstring

Price change rate as a decimal, for example 0.0523 for +5.23%

extend_stateinteger

Current trading session, used to show a session label during US pre-market, post-market, and overnight sessions:

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

Last price in the pre-market, post-market, or overnight session; ignore it when extend_state is 0

extend_chgstring

Price change rate in the pre-market, post-market, or overnight session, as a decimal

minutesarray<object>

Mini intraday chart points in ascending time order

Child attributes
pricestring

Price at this point

timestampstring

Unix timestamp of this point

minutes_countinteger

Total number of points in a full trading day, used to size the x-axis of the mini chart; when 0, derive it from the market's trading hours

Whale Docs