Per-underlying daily option volume/OI history
GET/api/v1.0/quote/{code}/option-underlying-his-statisticPer-underlying daily option volume/OI history. symbol is the equity or index (e.g. US.AAPL / HK.HSI). HK HSI/HSCEI need index_option_type. begin_time / end_time YYYY-MM-DD. OI is T-1 delayed; the latest trading day OI may be empty. For latest snapshot use quote.option_underlying_overview; for IV/HV history use quote.option_underlying_his_volatility.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
code | string | path | yes | Underlying symbol, e.g. US.AAPL |
begin_time | string | query | yes | Start date YYYY-MM-DD. Date YYYY-MM-DD in the security's market timezone |
end_time | string | query | yes | End date YYYY-MM-DD. Date YYYY-MM-DD in the security's market timezone |
index_option_type | int | query | no | HK HSI/HSCEI index-option type; omit for equities |
Example
bash
curl -X GET 'https://webapi.moomoo.com/api/v1.0/quote/US.AAPL/option-underlying-his-statistic?begin_time=value&end_time=value' \
-H 'Authorization: Bearer <AccessToken>' | jqResponse parameters
| Name | Type | Description |
|---|---|---|
data.statistics | object[] | |
data.statistics[].time | string | Trading day YYYY-MM-DD. Date YYYY-MM-DD in the security's market timezone |
data.statistics[].timestamp | int | Trading-day timestamp , Unix microseconds |
data.statistics[].call_volume | string | Call volume |
data.statistics[].put_volume | string | Put volume |
data.statistics[].call_open_interest | string | Call open interest (T-1 delayed) |
data.statistics[].put_open_interest | string | Put open interest (T-1 delayed) |
data.statistics[].underlying_price | string | Underlying price |
Errors
| ret_code | error.code | Description |
|---|---|---|
| 0 | — | Success |
| -3 | invalid_parameter | Missing or invalid parameter |
| -8 | unsupported | Not supported |
| -10 | no_data | No data |
Response example
json
{
"ret_code": 0,
"ret_msg": "success",
"data": {
"statistics": [
{
"time": "example",
"timestamp": 1710000000000000,
"call_volume": "example",
"put_volume": "example",
"call_open_interest": "example",
"put_open_interest": "example",
"underlying_price": "example"
}
]
}
}