News & Contents
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 sharelist detail including name, description, and constituent stocks.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Required | Sharelist ID |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
sharelist | object | Required | Sharelist information |
scopes | object | Optional | Subscription scope info |
id | integer | Required | Sharelist ID |
description | string | Optional | Description |
cover | string | Optional | Cover image URL |
subscribers_count | integer | Optional | Number of subscribers |
chg | string | Optional | Day change percentage |
this_year_chg | string | Optional | Year-to-date change |
subscribed | boolean | Optional | Whether subscribed |
sharelist_type | integer | Optional | Type: `0`=regular, `3`=official, `4`=industry |
industry_code | string | Optional | Industry code |
is_self | boolean | Optional | Whether the current user is the creator |
subscription | boolean | Optional | Whether the current user is subscribed |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"id": 123,
"name": "AI Picks",
"description": "Top AI infrastructure stocks",
"securities": [
"AAPL.US",
"NVDA.US"
]
}
}Error code
See the Error Codes page for the full list of error codes.