Fundamental
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 constituent stocks of an index or ETF with sorting options and rise/fall statistics.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Index or ETF symbol, e.g. `HSI.HK`, `SPY.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | Optional | Total number of matching stocks. |
└ symbol | string | Optional | Security symbol |
└ trade_status | integer | Optional | Trading status code |
└ last_done | string | Optional | Last trade price |
└ prev_close | string | Optional | Previous close |
└ inflow | string | Optional | Capital inflow |
└ balance | string | Optional | Market cap |
└ amount | string | Optional | Trading volume amount |
└ total_shares | string | Optional | Total shares |
└ circulating_shares | string | Optional | Circulating shares |
└ tags | array | Optional | Tags |
└ name | string | Optional | Security name |
└ market | string | Optional | Market |
└ intro | string | Optional | Brief description |
└ delay | boolean | Optional | Whether data is delayed |
└ chg | string | Optional | Price change percentage |
rise_num | integer | Optional | Number of rising stocks |
fall_num | integer | Optional | Number of falling stocks |
flat_num | integer | Optional | Number of flat stocks |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"fall_num": 10,
"flat_num": 3,
"rise_num": 7,
"stocks": [
{
"symbol": "9988.HK",
"name": "BABA-W",
"market": "HK",
"last_done": "140.90",
"prev_close": "132.80",
"chg": "0.0610",
"amount": "93828577",
"inflow": "18483450",
"balance": "13320299492",
"circulating_shares": "19192403958",
"total_shares": "19192403958",
"trade_status": 105,
"intro": "China's largest e-commerce platform",
"delay": false,
"tags": [
"Top gainers"
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.