Skip to content

Get User Security Group ​

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

Get the user's watchlist group list (including system preset groups and user custom groups). Use user-security to get symbols in a group; use modify-user-security to add/remove symbols.

Parameters ​

NameTypeInRequiredDescription
group_typestringquerynoGroup type filter. Default ALL. Values: ALL=all / SYSTEM=system preset / CUSTOM=user custom.

Request Example ​

bash
curl "https://webapi.futunn.com/api/v1.0/quote/user-security-group?group_type=ALL" | jq

Response Fields ​

NameTypeDescription
dataobject
data.group_listobject[]
data.group_list[].group_namestringGroup name. System groups are in English (e.g. All / US / HK / Favorites); custom groups keep the user-defined name (e.g. 我的自选)
data.group_list[].group_typestringGroup type. Values: SYSTEM (system preset) / CUSTOM (user-defined)
paginationobjectPagination returned by some endpoints

Supported Markets ​

  • Only returns groups currently visible to the user (hidden groups are excluded).
  • Holdings, forex, and fund groups are not included in the response.
  • System groups (group_type=SYSTEM) full name set (up to 19): All, Favorites, HK, US, CN, HK Options, US Options, Options, Futures, Index, Bonds, Notes, Crypto, SG, JP, MY, AU, CA.

Error Codes ​

ret_codeerror.codeTrigger ConditionHandling
-3invalid_parametergroup_type value not in [ALL, CUSTOM, SYSTEM] (case-sensitive).Correct group_type and retry.
-9permission_deniedUser identity missing/invalid.Add user identity and retry.
-5internal_errorService errorRetry later; contact support if persistent.

Response Example ​

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "group_list": [
      {
        "group_name": "All",
        "group_type": "SYSTEM"
      },
      {
        "group_name": "Favorites",
        "group_type": "SYSTEM"
      },
      {
        "group_name": "HK",
        "group_type": "SYSTEM"
      },
      {
        "group_name": "US",
        "group_type": "SYSTEM"
      },
      {
        "group_name": "Options",
        "group_type": "SYSTEM"
      },
      {
        "group_name": "我的自选",
        "group_type": "CUSTOM"
      }
    ]
  }
}