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 real-time call/put volume snapshot for today.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | US stock symbol, e.g. `AAPL.US`, `TSLA.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
c | string | Optional | Total call option volume. |
p | string | Optional | Total put option volume. |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"symbol": "AAPL.US",
"call_volume": 284512,
"put_volume": 195830
}
}Error code
See the Error Codes page for the full list of error codes.