Skip to content

Get User Security ​

GET /api/v1.0/quote/user-security

Get the watchlist (user security list) for a specified group. Returns each security's code, name, lot size, security type, and derivative information.

Request Parameters ​

ParameterTypePositionRequiredDescription
group_namestringqueryyesGroup name (URL-encoded), max 100 characters. Group names can be obtained from user-security-group.

Request Example ​

bash
curl -G "https://webapi.futunn.com/api/v1.0/quote/user-security" \
  --data-urlencode 'group_name=美股期权' | jq

Response Fields ​

NameTypeDescription
dataobject
data.security_listobject[]
data.security_list[].codestringStock symbol, e.g. HK.00019
data.security_list[].namestringEnglish name, e.g. Swire Pacific A
data.security_list[].sc_namestringSimplified Chinese name
data.security_list[].tc_namestringTraditional Chinese name
data.security_list[].lot_sizeintLot size (option = contract shares, future = contract multiplier), e.g. 500
data.security_list[].stock_typestringSecurity type, e.g. STOCK / ETF / WARRANT / DRVT / FUTURE / IDX / BOND
data.security_list[].stock_child_typeintSecurity sub-type value (security sub-type enum enum), e.g. 3002
data.security_list[].stock_ownerstringUnderlying stock symbol (the underlying for warrant/option), e.g. HK.00700; empty string for non-derivatives
data.security_list[].option_typestringOption type. Values: ALL / CALL / PUT / UNKNOWN (returns ALL for non-options)
data.security_list[].strike_timestringOption strike date, format yyyy-MM-dd, e.g. 2026-06-29; empty string for non-options
data.security_list[].strike_pricenumberOption strike price, e.g. 390.0; 0 for non-options
data.security_list[].listing_datestringListing date string, format yyyy-MM-dd, e.g. 1972-11-01; returns empty string if absent
data.security_list[].stock_idintSecurity ID (numeric identifier), e.g. 19
data.security_list[].main_contractboolWhether the symbol is a futures main-continuous contract, e.g. false (always false for non-futures)
data.security_list[].last_trade_timestringLast trading date for option/future, format yyyy-MM-dd; empty string when not applicable
paginationobjectPagination returned by some endpoints

Supported Markets ​

  • Markets: No restriction. Watchlist can contain securities from HK / US / A-shares / JP / SG / AU / MY / CA and any other market.
  • Categories: No restriction. Stocks / ETF / warrants / options / futures / indices / bonds / cryptocurrency etc. can all appear.
  • An empty group returns security_list as an empty array (valid, not an error).

Error Codes ​

ret_codeerror.codeTrigger ConditionHandling
0--Success (empty group returns empty array).Parse security_list normally.
-3invalid_parameterMissing group_name / exceeds 100 chars / group name does not exist.Validate input; use user-security-group to confirm group name.
-9permission_deniedUser identity missing/invalid.Add user identity and retry.
-5internal_errorService errorRetry; contact support if persistent.

Response Example ​

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "security_list": [
      {
        "code": "US.SPY260526C735000",
        "name": "SPY 260526 735.00C",
        "lot_size": 100,
        "stock_type": "DRVT",
        "stock_child_type": 8002,
        "stock_owner": "US.SPY",
        "option_type": "CALL",
        "strike_time": "2026-05-26",
        "strike_price": 735.0,
        "listing_date": "",
        "stock_id": 507601755,
        "main_contract": false,
        "last_trade_time": ""
      }
    ]
  }
}