Skip to content

Heat-map of industry / concept / theme plates in a market ​

GET /api/v1.0/quote/heatmap

Heat-map of industry / concept / theme plates in a market, sorted by change rate / market cap / turnover / hot. Returns plate code and name, last price, change rate, turnover / volume, market cap, average PE, rise/fall/flat counts, leader stock, description. count defaults to 30 (max 200), matching OpenD. For rise/fall buckets use quote.heatmap.rise_fall_distribution.

Parameters ​

NameTypeInRequiredDescription
marketstringqueryyesMarket code. SH and SZ share the A-share plate set
plate_typestringquerynoPlate type, default INDUSTRY. THEME maps to the special plate set
sort_fieldstringquerynoSort field, default CHANGE_RATE
sort_dirstringquerynoSort direction, default DESCENDING
page_flagstringquerynoPage cursor. Omit or pass empty on the first page; pass back pagination.page_flag. Stop only when pagination.completed is true
page_sizeintquerynoPage size, default 30, max 200

Example ​

bash
curl -X GET 'https://webapi.moomoo.com/api/v1.0/quote/heatmap?market=HK' \
  -H 'Authorization: Bearer <AccessToken>' | jq

Response parameters ​

NameTypeDescription
data.itemsobject[]
data.items[].platestringPlate symbol, e.g. HK.BK1001
data.items[].plate_namestringPlate name
data.items[].cur_pricestringPlate last price
data.items[].change_ratenumberChange rate in percent
data.items[].turnoverstringTurnover
data.items[].volumestringVolume
data.items[].market_valnumberMarket cap
data.items[].pe_avgnumberAverage PE
data.items[].rise_countintNumber of rising constituents
data.items[].fall_countintNumber of falling constituents
data.items[].equal_countintNumber of unchanged constituents
data.items[].leader_stockintLeader stock symbol
data.items[].descriptionstringPlate description
pagination.totalint
pagination.completedboolTrue when this is the last page. Stop paging only when completed is true
pagination.page_flagstringNext page cursor. Pass it back as page_flag while completed is false; empty on the last page

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": [
      {
        "plate": "example",
        "plate_name": "example",
        "cur_price": "example",
        "change_rate": 1.2,
        "turnover": "example",
        "volume": "example",
        "market_val": 1.2,
        "pe_avg": 1.2,
        "rise_count": 0,
        "fall_count": 0,
        "equal_count": 0,
        "leader_stock": 0,
        "description": "example"
      }
    ]
  },
  "pagination": {
    "page_flag": "",
    "completed": true,
    "total": 0
  }
}