Latest option stats for up to 500 underlyings

POST /api/v1.0/quote/option-underlying-overview

Latest option stats for up to 500 underlyings (volume/OI/IV/HV). HK HSI/HSCEI may pass index_option_type. Returns per-symbol call/put volume and OI, IV/IV rank/percentile, multi-horizon HV, previous-day IV. For history use quote.option_underlying_his_statistic / quote.option_underlying_his_volatility.

Parameters

Name	Type	In	Required	Description
codes	string	body	yes	Underlying symbols, max 500, e.g. ["US.AAPL","US.TSLA"]
index_option_type	int	body	no	HK HSI/HSCEI index-option type; omit for equities

Example

curl -X POST 'https://webapi.moomoo.com/api/v1.0/quote/option-underlying-overview' -H 'Content-Type: application/json' -d '{}' \
  -H 'Authorization: Bearer <AccessToken>' | jq

Response parameters

Name	Type	Description
data.items	object[]
data.items[].code	string	Underlying symbol
data.items[].name	string	Underlying name
data.items[].call_volume	string	Call volume
data.items[].put_volume	string	Put volume
data.items[].call_open_interest	string	Call open interest (T-1)
data.items[].put_open_interest	string	Put open interest (T-1)
data.items[].iv	number	Implied volatility (percent)
data.items[].iv_rank	number	IV rank (percent)
data.items[].iv_percentile	number	IV percentile (percent)
data.items[].pre_iv	number	Previous-session IV (percent)
data.items[].historical_volatilities	object[]
data.items[].historical_volatilities[].time_range	int	HV horizon in days: 30/60/90/120/365/1095
data.items[].historical_volatilities[].hv	number	Historical volatility (percent)

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

{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "items": [
      {
        "code": "US.AAPL",
        "name": "example",
        "call_volume": "example",
        "put_volume": "example",
        "call_open_interest": "example",
        "put_open_interest": "example",
        "iv": 1.2,
        "iv_rank": 1.2,
        "iv_percentile": 1.2,
        "pre_iv": 1.2,
        "historical_volatilities": "example"
      }
    ]
  }
}