Skip to content

Plate Stock ​

GET /api/v1.0/quote/plate-stock

Get the list of stock members under a specified plate (sector), with sorting and pagination support.

Parameters ​

NameTypeInRequiredDescription
plate_codestringqueryyesPlate code (from quote.plate_list), e.g. HK.LIST1045 Max length 32; Pattern ^[A-Z0-9_]+\.[A-Za-z0-9_.\-]+$
sort_fieldstringquerynoSort field. Default NONE. See Naming Dictionary. Default "NONE"
ascendboolquerynoWhether to sort in ascending order, default true. e.g. true=ascending / false=descending Default true
price_typestringquerynoPrice scope for price-related sorting: NORMAL / BEFORE / AFTER / OVERNIGHT. Default NORMAL Default "NORMAL"; Values NORMAL, BEFORE, AFTER, OVERNIGHT
leverage_directionintquerynoETF leverage direction filter (ETF plates only): 0=all / 1=long / 2=short. Default 0 ≥ 0; ≤ 2; Default 0
leverage_multipleintquerynoETF leverage multiple filter (ETF plates only), scaled by 10^3, e.g. 2000=2x / 1500=1.5x / 0=all. Default 0 ≥ 0; Default 0
next_keystringquerynoPagination cursor (empty for first page). Pass back pagination.next_key; stop when pagination.has_more=false Max length 1000; Pattern ^$|^(-?[0-9]+)?$
limitintquerynoPage size, default 200, max 1000 ≤ 1000; Default 200

Request Example ​

bash
curl 'https://webapi.futunn.com/api/v1.0/quote/plate-stock?plate_code=HK.LIST1045&limit=2' | jq

Response Fields ​

Returns data.stock_list[] as the plate constituent stock list; pagination info in top-level pagination.

NameTypeDescription
dataobject
data.stock_listobject[]
data.stock_list[].codestringStock symbol with market prefix, e.g. HK.02337
data.stock_list[].lot_sizeintLot size (option=contract shares, futures=contract multiplier), e.g. 1000
data.stock_list[].stock_namestringEnglish name
data.stock_list[].sc_namestringSimplified Chinese name
data.stock_list[].tc_namestringTraditional Chinese name
data.stock_list[].stock_typestringSecurity type, e.g. STOCK / ETF / WARRANT / FUTURE / DRVT, etc.
data.stock_list[].list_timeintListing time, millisecond timestamp; 0 if missing, e.g. 1508083200000
data.stock_list[].stock_idintStock ID (numeric identifier), e.g. 74891344742689
paginationobject
pagination.totalint
pagination.has_morebool
pagination.next_keystring

Supported Markets ​

  • Markets: HK / US / SH / SZ / SG / JP / CA / AU / MY / KR and all markets (consistent with plates returned by the plate list API).
  • ETF leverage filters (leverage_direction / leverage_multiple) only take effect for ETF plates; they are ignored for other plates even if passed.
  • price_type only affects the value source for price-type sort fields.

Error Codes ​

ret_codeerror.codeTrigger ConditionHandling
0--Success (valid plate with no constituents returns empty stock_list with pagination.total=0)--
-3invalid_parameterMissing plate_code / plate_code doesn't match market prefix regex / sort_field not in enum / price_type not in enum / limit exceeds 1000 / invalid next_keyCorrect request parameters and retry
-7invalid_symbolplate_code cannot resolve to a valid plate (code does not exist or has been delisted)Get valid plate codes from the plate list API
-4internal_errorService errorRetry; contact support if persistent

Response Example ​

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "stock_list": [
      {
        "code": "HK.02337",
        "stock_id": 74891344742689,
        "stock_name": "众诚能源",
        "stock_type": "STOCK",
        "lot_size": 1000,
        "list_time": 1508083200000
      },
      {
        "code": "HK.01193",
        "stock_id": 38976828212393,
        "stock_name": "华润燃气",
        "stock_type": "STOCK",
        "lot_size": 100,
        "list_time": 784137600000
      }
    ]
  },
  "pagination": {
    "has_more": true,
    "next_key": "2",
    "total": 22
  }
}