Skip to content
Market Rankings

Get Market Home Ranking Securities

Lists securities in a ranking of the market home ranking module, with page support. Returns a price snapshot, the sort indicator value, a one-line description, and mini intraday chart data. Take the category parameters from Get Market Home Ranking Categories. Paginate with offset and limit; fewer than limit items means there is no more data.

GEThttps://api.lbkrs.com/v4/discovery/stock/ranklist

Parameters

marketstringqueryRequired

Market code, that is, markets[].key, for example US

keystringqueryRequired

Ranking key, that is, categories[].key

v2_keystringquery

New ranking key, that is, categories[].v2_key

idstringquery

Ranking category ID, that is, categories[].id

indicatorstringquery

Sort indicator key, that is, categories[].indicator

orderstringquery

Sort direction:

  • 1 - Descending
  • 2 - Ascending

12

filter_penny_stockbooleanquery

Whether to filter out penny stocks; takes effect only when filter_penny_stock of the category is true

offsetintegerqueryRequired

Page offset starting at 0

limitintegerqueryRequired

Number of items per page

Responses

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

Total number of securities in the ranking

marketstring

Market code

stocksarray<object>

Ranked securities, ordered by the sort indicator

Child attributes
counter_idstring

Security ID

namestring

Security name

last_donestring

Last price

prev_closestring

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

valuestring

Value of the sort indicator; display it by the format and color of the ranking category

descstring

One-line description of the security

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

Whale Docs