Skip to content
Market Rankings

Get Ranking Widget Securities

Retrieves the top securities shown in the ranking widget by ranking type and market, with price, change rate, and the trading session of the price. The server handles the sort direction and US extended-session prices (pre-market, post-market, overnight), so no sort parameters are needed. Use it for the card-style ranking widget on the home page, calling once per market as the user swipes between markets.

Top gainers and top losers support HK, US, CN, and SG; popular trades and trending now support HK and US.

GEThttps://api.lbkrs.com/quote/market/rank/widget

Parameters

marketstringqueryRequired

Market code:

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

USHKCNSG

keystringqueryRequired

Ranking type:

  • widget-top_gainers - Top gainers
  • widget-top_losers - Top losers
  • widget-ib_trade_heat - Popular trades
  • widget-ib_hot_all - Trending now

widget-top_gainerswidget-top_loserswidget-ib_trade_heatwidget-ib_hot_all

offsetintegerqueryRequired

Offset; the widget shows only the top entries, so pass 0

limitintegerqueryRequired

Number of items to return

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Ranking Widget Securities” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listsarray<object>

Ranked securities in ranking order; show an empty state when empty

Child attributes
counter_idstring

Security ID

namestring

Security name

codestring

Ticker symbol, for example AAPL

last_donestring

Last price; for US stocks in the pre-market, post-market, or overnight session, the price in that session

chgstring

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

stateinteger

Trading session of the price; show a session label only for US stocks:

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