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 hierarchical sub-sector tree for an industry group, including stock count, daily change, and YTD change at each node. Counter IDs come from industry_rank.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Industry symbol, e.g. `IN20245.HK`. |
market | string | Required | Market code: `US` / `HK` / `CN` / `SG` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
top | object | Optional | Top-level industry info |
chain | object | Optional | Industry hierarchy root node |
market | string | Optional | Market code |
symbol | string | Optional | Sector symbol (present on the root node; empty string on child nodes). |
stock_num | integer | Optional | Number of stocks in this sector |
chg | string | Optional | Daily change (decimal; may be empty string) |
ytd_chg | string | Optional | Year-to-date change (decimal; may be empty string) |
next | object[] | Optional | Child sector list with the same structure (recursive) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"top": {
"name": "All Industries",
"market": "US"
},
"chain": {
"name": "Technology",
"symbol": "IN00258.US",
"stock_num": 542,
"chg": "0.0231",
"ytd_chg": "0.0875",
"next": [
{
"name": "Online Consumer Electronics Retail",
"symbol": "",
"stock_num": 4,
"chg": "0.0268",
"ytd_chg": "-0.1869",
"next": []
}
]
}
}
}Error code
See the Error Codes page for the full list of error codes.