Quote
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 daily short sale volume data for an HK stock from HKEX, updated each trading day.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol; supports US (e.g. `TSLA.US`) and HK (e.g. `700.HK`) |
count | integer | Optional | Number of records to return (1–100, default 20) |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Optional | Security symbol, e.g. `700.HK`. |
data | object[] | Optional | Daily HKEX short-sale records. |
└ timestamp | string | Optional | Trade date (Unix seconds). |
└ amount | string | Optional | Short-sale turnover that day. |
└ balance | string | Optional | Short-sale balance. |
└ close | string | Optional | Closing price. |
└ rate | string | Optional | Short-sale ratio. |
└ total_amount | string | Optional | Total market turnover. |
Response JSON example
{
"code": 0,
"message": "success",
"data": [
{
"timestamp": "2026-05-15T04:00:00Z",
"nus_amount": "5748485",
"ny_amount": "0",
"total_amount": "15778974",
"rate": "0.3643",
"close": "300.230"
}
]
}Error code
See the Error Codes page for the full list of error codes.