Market
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get the stock ranking for a given leaderboard tag key. The key comes from rank_categories second_tags[].key, e.g. hot_all-us (US total hotness).
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Required | Leaderboard tag key from `rank_categories` `second_tags[].key` |
need_article | boolean | Optional | Whether to return associated articles, default `false` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
bmp | boolean | Optional | Whether the response is a market preview (before open) |
lists | object[] | Optional | Leaderboard stock list |
└ code | string | Optional | Ticker code (e.g. `MU`) |
└ symbol | string | Optional | Symbol in `CODE.MARKET` format (e.g. `MU.US`) |
└ name | string | Optional | Security name |
└ last_done | string | Optional | Latest trade price |
└ chg | string | Optional | Price change ratio as decimal (e.g. `0.0252` = 2.52%) |
└ change | string | Optional | Absolute price change (e.g. `17.200`) |
└ inflow | string | Optional | Net capital inflow (in the market's currency) |
└ market_cap | string | Optional | Market capitalisation |
└ industry | string | Optional | Industry classification |
└ pre_post_price | string | Optional | Pre/post-market price |
└ pre_post_chg | string | Optional | Pre/post-market price change ratio (decimal) |
└ amplitude | string | Optional | Amplitude / intraday range ratio (decimal) |
└ five_day_chg | string | Optional | 5-day price change ratio (decimal) |
└ turnover_rate | string | Optional | Turnover rate (decimal) |
└ volume_rate | string | Optional | Volume ratio (vs average) |
└ pb_ttm | string | Optional | Price-to-book ratio (TTM) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"bmp": false,
"lists": [
{
"code": "MU",
"symbol": "MU.US",
"name": "Micron Technology",
"last_done": "698.740",
"chg": "0.0252",
"change": "17.200",
"inflow": "-347041642",
"market_cap": "787992890796",
"industry": "Semiconductor Manufacturers",
"pre_post_price": "726.600",
"pre_post_chg": "0.0399",
"amplitude": "0.1082",
"five_day_chg": "-0.0885",
"turnover_rate": "0.0550",
"volume_rate": "1.11",
"pb_ttm": "32.68"
}
]
}
}Error code
See the Error Codes page for the full list of error codes.