Get User Security
GET/api/v1.0/quote/user-securityGet the watchlist (user security list) for a specified group. Returns each security's code, name, lot size, security type, and derivative information.
Request Parameters
| Parameter | Type | Position | Required | Description |
|---|---|---|---|---|
group_name | string | query | yes | Group 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=美股期权' | jqResponse Fields
| Name | Type | Description |
|---|---|---|
data | object | |
data.security_list | object[] | |
data.security_list[].code | string | Stock symbol, e.g. HK.00019 |
data.security_list[].name | string | English name, e.g. Swire Pacific A |
data.security_list[].sc_name | string | Simplified Chinese name |
data.security_list[].tc_name | string | Traditional Chinese name |
data.security_list[].lot_size | int | Lot size (option = contract shares, future = contract multiplier), e.g. 500 |
data.security_list[].stock_type | string | Security type, e.g. STOCK / ETF / WARRANT / DRVT / FUTURE / IDX / BOND |
data.security_list[].stock_child_type | int | Security sub-type value (security sub-type enum enum), e.g. 3002 |
data.security_list[].stock_owner | string | Underlying stock symbol (the underlying for warrant/option), e.g. HK.00700; empty string for non-derivatives |
data.security_list[].option_type | string | Option type. Values: ALL / CALL / PUT / UNKNOWN (returns ALL for non-options) |
data.security_list[].strike_time | string | Option strike date, format yyyy-MM-dd, e.g. 2026-06-29; empty string for non-options |
data.security_list[].strike_price | number | Option strike price, e.g. 390.0; 0 for non-options |
data.security_list[].listing_date | string | Listing date string, format yyyy-MM-dd, e.g. 1972-11-01; returns empty string if absent |
data.security_list[].stock_id | int | Security ID (numeric identifier), e.g. 19 |
data.security_list[].main_contract | bool | Whether the symbol is a futures main-continuous contract, e.g. false (always false for non-futures) |
data.security_list[].last_trade_time | string | Last trading date for option/future, format yyyy-MM-dd; empty string when not applicable |
pagination | object | Pagination 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_listas an empty array (valid, not an error).
Error Codes
| ret_code | error.code | Trigger Condition | Handling |
|---|---|---|---|
| 0 | -- | Success (empty group returns empty array). | Parse security_list normally. |
| -3 | invalid_parameter | Missing group_name / exceeds 100 chars / group name does not exist. | Validate input; use user-security-group to confirm group name. |
| -9 | permission_denied | User identity missing/invalid. | Add user identity and retry. |
| -5 | internal_error | Service error | Retry; 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": ""
}
]
}
}