Skip to content

Option seller screener ​

GET /api/v1.0/quote/option-seller-screener

Option seller screener. option_market: US_SECURITY / HK_SECURITY; seller_type: COVERED_CALL / CASH_SECURED_PUT. Returns contract, strike/expiry, premium, OTM degree, annualized/interval return, exercise probability.

Parameters ​

NameTypeInRequiredDescription
option_marketstringqueryyesOption market. US_SECURITY / HK_SECURITY
seller_typestringqueryyesSeller strategy. COVERED_CALL / CASH_SECURED_PUT
sort_typestringquerynoSort field, default ANNUALIZED_RETURN
is_ascboolquerynoAscending; default false

Example ​

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

Response parameters ​

NameTypeDescription
data.itemsobject[]
data.items[].codestringOption contract symbol
data.items[].namestringOption name
data.items[].option_typeintCALL / PUT
data.items[].strike_pricestringStrike price
data.items[].strike_timestampintExpiry timestamp , Unix microseconds
data.items[].left_daysintDays to expiry
data.items[].option_pricestringOption price
data.items[].stock_pricestringUnderlying price
data.items[].premiumstringPremium
data.items[].otm_degreenumberOTM degree (percent)
data.items[].ivnumberIV (percent)
data.items[].interval_returnnumberInterval return (percent)
data.items[].annualized_returnnumberAnnualized return (percent)
data.items[].itm_probabilitynumberExercise probability (percent)
data.items[].striked_interval_returnnumberPost-exercise interval return (percent, Covered Call)
data.items[].striked_annualized_returnnumberPost-exercise annualized return (percent, Covered Call)
data.items[].ownerstringUnderlying symbol
pagination.totalintMatch count (may be capped)

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": {
    "items": [
      {
        "code": "US.AAPL",
        "name": "example",
        "option_type": 0,
        "strike_price": "example",
        "strike_timestamp": 1710000000000000,
        "left_days": 0,
        "option_price": "example",
        "stock_price": "example",
        "premium": "example",
        "otm_degree": 1.2,
        "iv": 1.2,
        "interval_return": 1.2,
        "annualized_return": 1.2,
        "itm_probability": 1.2,
        "striked_interval_return": 1.2,
        "striked_annualized_return": 1.2,
        "owner": "example"
      }
    ]
  },
  "pagination": {
    "total": 0
  }
}