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 historical daily call/put volume and open interest data for a US stock's options.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Underlying US stock symbol, e.g. `AAPL.US`, `TSLA.US` |
timestamp | integer | Optional | Start Unix timestamp (seconds); `0` returns the most recent (default `0`) |
count | integer | Optional | Number of trading days to return (default `30`) |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
stats | object[] | Required | Daily volume records. |
└ symbol | string | Required | Security symbol, e.g. `AAPL.US`. |
└ timestamp | string | Required | Record date (Unix seconds). |
└ total_call_volume | string | Required | Call volume on that day. |
└ total_put_volume | string | Required | Put volume on that day. |
└ total_call_open_interest | string | Required | Call open interest. |
└ total_put_open_interest | string | Required | Put open interest. |
└ total_volume | string | Required | Total options volume. |
└ total_open_interest | string | Required | Total options open interest. |
└ put_call_volume_ratio | string | Required | Put/call volume ratio. |
└ put_call_open_interest_ratio | string | Required | Put/call open interest ratio. |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"symbol": "AAPL.US",
"stats": [
{
"symbol": "AAPL.US",
"date": "2026-05-07",
"call_volume": 284512,
"put_volume": 195830,
"call_open_interest": 1824500,
"put_open_interest": 1532100,
"total_volume": 480342,
"total_open_interest": 3356600,
"pc_vol": 0.6886,
"pc_oi": 0.8398
}
]
}
}Error code
See the Error Codes page for the full list of error codes.