Market-wide daily option volume or open interest

GET /api/v1.0/quote/option-market-statistic

Market-wide daily option volume or open interest. option_market: US_SECURITY / US_INDEX / HK_SECURITY / HK_INDEX; data_type: VOLUME / OPEN_INTEREST. Date range begin_time / end_time (YYYY-MM-DD) max 365 days. Returns daily call/put/total and put/call ratio, trading-day descending. For a single underlying use quote.option_underlying_his_statistic.

Parameters

Name	Type	In	Required	Description
option_market	string	query	yes	Option market. US_SECURITY / US_INDEX / HK_SECURITY / HK_INDEX
data_type	string	query	yes	Statistic type. VOLUME / OPEN_INTEREST (delayed)
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; span at most 365 days. Date YYYY-MM-DD in the security's market timezone

Example

curl -X GET 'https://webapi.moomoo.com/api/v1.0/quote/option-market-statistic?option_market=US_SECURITY&data_type=VOLUME' \
  -H 'Authorization: Bearer <AccessToken>' | jq

Response 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_value	string	Call total (volume or OI, per data_type)
data.statistics[].put_value	string	Put total
data.statistics[].total_value	string	Call+Put total
data.statistics[].ratio	string	Put/Call ratio; 0 when call is 0

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": {
    "statistics": [
      {
        "time": "example",
        "timestamp": 1710000000000000,
        "call_value": "example",
        "put_value": "example",
        "total_value": "example",
        "ratio": "example"
      }
    ]
  }
}