Skip to content

Option contract rank ​

GET /api/v1.0/quote/option-rank

Option contract rank. option_market as above; sort_type default VOLUME. count default 50 (max 200). Returns contract code/name, CALL/PUT, volume/turnover, OI, IV, price change, greeks (subset). For free-form screening use quote.option_screen; for underlying rank use quote.option_underlying_rank.

Parameters ​

NameTypeInRequiredDescription
option_marketstringqueryyesOption market. US_SECURITY / US_INDEX / HK_SECURITY / HK_INDEX
sort_typestringquerynoSort type, default VOLUME
is_ascboolquerynoAscending; default false
page_sizeintquerynoPage size, default 50, max 200
page_flagstringquerynoPage cursor. Omit or pass empty on the first page; pass back pagination.page_flag. Stop only when pagination.completed is true
trading_datestringquerynoTrading day YYYY-MM-DD; omit for latest. Date YYYY-MM-DD in the security's market timezone

Example ​

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

Response parameters ​

NameTypeDescription
data.ranksobject[]
data.ranks[].codestringOption contract symbol
data.ranks[].namestringOption name
data.ranks[].option_typeintCALL / PUT
data.ranks[].volumestringVolume
data.ranks[].turnoverstringTurnover
data.ranks[].open_intereststringOpen interest
data.ranks[].oi_incrementintDaily OI increase (>=0)
data.ranks[].oi_decrementintDaily OI decrease (>=0)
data.ranks[].ivnumberImplied volatility (percent)
data.ranks[].option_pricestringOption last price
data.ranks[].change_ratenumberChange rate (percent)
data.ranks[].mid_pricestringMid price
data.ranks[].bid_pricestringBid
data.ranks[].ask_pricestringAsk
data.ranks[].bid_volumestringBid size
data.ranks[].ask_volumestringAsk size
data.ranks[].deltanumberDelta
data.ranks[].gammanumberGamma
data.ranks[].thetanumberTheta
data.ranks[].veganumberVega
data.ranks[].rhonumberRho
data.trading_datestringActual query trading day
pagination.totalint
pagination.completedboolTrue when this is the last page. Stop paging only when completed is true
pagination.page_flagstringNext page cursor. Pass it back as page_flag while completed is false; empty on the last page

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": {
    "ranks": [
      {
        "code": "US.AAPL",
        "name": "example",
        "option_type": 0,
        "volume": "example",
        "turnover": "example",
        "open_interest": "example",
        "oi_increment": 0,
        "oi_decrement": 0,
        "iv": 1.2,
        "option_price": "example",
        "change_rate": 1.2,
        "mid_price": "example",
        "bid_price": "example",
        "ask_price": "example",
        "bid_volume": "example",
        "ask_volume": "example",
        "delta": 1.2,
        "gamma": 1.2,
        "theta": 1.2,
        "vega": 1.2,
        "rho": 1.2
      }
    ],
    "trading_date": "2026-10-16"
  },
  "pagination": {
    "page_flag": "",
    "completed": true,
    "total": 0
  }
}