Rank List
rank_listRetrieve ranked stock lists by leaderboard category keys for US, HK, CN, and SG markets. Specify the tab key, market, and result count to get heat rankings, rising stocks, or hot trades.
Instructions
Get ranked stock list by leaderboard tab key. key: from rank_categories second_tags[].key (e.g. "hot_all-us", "hot_up-hk", "trade_heat-us"). market: inferred from key suffix (-us/-hk) or pass explicitly. size: results (default 20).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | Tab key from rank_categories second_tags[].key, e.g. "hot_all-us" (US total heat), "hot_up-hk" (HK rising heat), "trade_heat-us" (US hot trades). The "ib_" prefix is stripped from rank_categories keys and added back automatically. | |
| size | No | Number of results to return (default: 20) | |
| market | No | Market override: "US" | "HK" | "CN" | "SG". Defaults to the market suffix in the key (e.g. "ib_hot_all-hk" → HK), then "US". | |
| need_article | No | Whether to include related news articles (default: false) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lists | No | ||
| updated_at | No |