Skip to content
Market Rankings

Get Ranking Configuration

Retrieves the ranking configuration of a market: first-level categories, second-level rankings, and for each ranking its indicator columns, default sort, and whether penny stocks can be filtered out. Use it to render the category tabs and column headers of the market ranking page and the ranking module on the market home page. Then call Get Ranking Securities with first_categories[].key, sec_categories[].key, and an indicator key.

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

Parameters

marketstringqueryRequired

Market code:

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

USHKCNSG

scenestringqueryRequired

Usage scene:

  • index - Ranking module on the market home page; each ranking returns at most 2 indicators, and they cannot be sorted
  • extra - Ranking detail page

indexextra

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Ranking Configuration” 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 Get Ranking Securities

namestring

Category name

sec_categoriesarray<object>

Second-level rankings in this category

Child attributes
keystring

Second-level ranking key; pass it as sec_category to Get Ranking Securities

namestring

Ranking name

descstring

One-line description of the ranking

filter_penny_stockboolean

Whether the ranking supports filtering out penny stocks; show the penny stock filter when true

master_indicatorstring

Default sort indicator key

default_orderstring

Default sort direction:

  • desc - Descending
  • asc - Ascending
indicatorsarray<object>

Indicator columns, in the same order as list[].indicators returned by Get Ranking Securities

Child attributes
keystring

Indicator key, for example last_done or chg; pass it to the list operation as the sort indicator

namestring

Display name of the indicator, used as the column header

is_sortboolean

Whether the column can be sorted

formatstring

Display format of the indicator value:

  • percent_signed - Multiply by 100 and show as a signed percentage
  • percent - Multiply by 100 and show as a percentage
  • big - Show as an abbreviated large number
  • raw - Show as is
colorstring

How to color the indicator value:

  • volatile - Use up and down colors by sign
  • regular - Use the regular text color
Whale Docs