Skip to content

Per-underlying daily option volume/OI history ​

GET /api/v1.0/quote/{code}/option-underlying-his-statistic

Per-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 ​

NameTypeInRequiredDescription
codestringpathyesUnderlying symbol, e.g. US.AAPL
begin_timestringqueryyesStart date YYYY-MM-DD. Date YYYY-MM-DD in the security's market timezone
end_timestringqueryyesEnd date YYYY-MM-DD. Date YYYY-MM-DD in the security's market timezone
index_option_typeintquerynoHK 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>' | jq

Response parameters ​

NameTypeDescription
data.statisticsobject[]
data.statistics[].timestringTrading day YYYY-MM-DD. Date YYYY-MM-DD in the security's market timezone
data.statistics[].timestampintTrading-day timestamp , Unix microseconds
data.statistics[].call_volumestringCall volume
data.statistics[].put_volumestringPut volume
data.statistics[].call_open_intereststringCall open interest (T-1 delayed)
data.statistics[].put_open_intereststringPut open interest (T-1 delayed)
data.statistics[].underlying_pricestringUnderlying price

Errors ​

ret_codeerror.codeDescription
0—Success
-3invalid_parameterMissing or invalid parameter
-8unsupportedNot supported
-10no_dataNo 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"
      }
    ]
  }
}