> For the complete documentation index, see [llms.txt](https://docs.infoway.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.infoway.io/en-docs/rest-api/get-basic-info/get-plate-data.md).

# GET Sector Data

### Description

This group of endpoints provides sector-level data, including industry sector lists, concept sector lists, sector constituent queries, and AI-generated industry analysis.

### Rate Limit

Shares the same rate limit with other endpoints. Refer to [API Rate Limits](https://docs.infoway.io/getting-started/api-limitation).

### Error Codes

Refer to [HTTP Error Codes](https://docs.infoway.io/getting-started/error-codes/http).

### Request Headers

| Parameter | Type   | Required | Description  |
| --------- | ------ | -------- | ------------ |
| `apiKey`  | String | Yes      | Your API Key |

### Multi-language Support (I18n)

All endpoints on this page support multi-language responses. Append the `lang` query parameter to control the language of the name-type fields in the response:

| Parameter | Type   | Required | Description                                                | Example |
| --------- | ------ | -------- | ---------------------------------------------------------- | ------- |
| `lang`    | String | No       | `en` for English (default); `zh-CN` for Simplified Chinese | `zh-CN` |

The two languages are cached independently and do not affect each other. Any other value falls back to the default `en` without raising an error.

**Fields affected by `lang`**

| Endpoint              | Field                    | `lang=zh-CN`               | `lang=en`                                                      |
| --------------------- | ------------------------ | -------------------------- | -------------------------------------------------------------- |
| Industry Sector List  | `name`                   | 系统软件                       | Systems Software                                               |
| Concept Sector List   | `name`                   | 恒大系                        | Evergrande                                                     |
| Sector Constituents   | `data.members[].name`    | 渣打集团                       | STANCHART                                                      |
| Industry Introduction | `intro`                  | 「多元化银行」包括提供广泛金融服务的大型银行机构…… | Large, geographically diverse banks with a national footprint… |
| Sector Heatmap Chart  | `name`, `members[].name` | 多元化银行 / 汇丰控股               | Diversified Banks / HSBC HOLDINGS                              |

### Sector Code Format

| Type            | Format                | Example                          |
| --------------- | --------------------- | -------------------------------- |
| Industry Sector | `IN{digits}.{market}` | `IN20293.HK` (Diversified Banks) |
| Concept Sector  | `CP{digits}.{market}` | `CP20027.HK` (Biotech B-shares)  |

### Supported Markets

`HK` (Hong Kong), `US` (United States), `CN` (China A-shares)

***

### Industry Sector List

Get all industry sectors for a given market.

**Endpoint**

* Base path: `/common/v2/basic/plate/industry/{market}`
* Full path: `https://data.infoway.io/common/v2/basic/plate/industry/{market}`

**Path Parameters**

| Parameter | Type   | Required | Description | Example |
| --------- | ------ | -------- | ----------- | ------- |
| `market`  | String | Yes      | Market code | `HK`    |

**Query Parameters**

| Parameter | Type    | Required | Description                           | Example |
| --------- | ------- | -------- | ------------------------------------- | ------- |
| `limit`   | Integer | No       | Number of results, 1-300, default 200 | `200`   |

**Response Example**

```json
{
  "market": "HK",
  "count": 5,
  "data": [
    {
      "symbol": "IN20335.HK",
      "counter_id": "BK/HK/IN20335",
      "name": "Security and Alarm Services",
      "type": "industry",
      "chg": "0.0615",
      "last_done": "490.292",
      "change": "28.417",
      "rise": "1",
      "fall": "0",
      "total_amount": "3740100",
      "market_cap": "715513802"
    }
  ]
}
```

| Field          | Type   | Description                         |
| -------------- | ------ | ----------------------------------- |
| `symbol`       | String | Sector code                         |
| `counter_id`   | String | Internal traceability ID            |
| `name`         | String | Sector name                         |
| `type`         | String | Sector classification               |
| `chg`          | String | Overall price change percentage     |
| `last_done`    | String | Current sector point (latest price) |
| `change`       | String | Change in points                    |
| `rise`         | String | Number of advancing stocks          |
| `fall`         | String | Number of declining stocks          |
| `total_amount` | String | Trading amount                      |
| `market_cap`   | String | Total market capitalization         |

***

### Concept Sector List

Get concept/trending sectors for a given market (not available for A-shares).

**Endpoint**

* Base path: `/common/v2/basic/plate/concept/{market}`
* Full path: `https://data.infoway.io/common/v2/basic/plate/concept/{market}`

**Path Parameters**

| Parameter | Type   | Required | Description | Example |
| --------- | ------ | -------- | ----------- | ------- |
| `market`  | String | Yes      | Market code | `HK`    |

**Query Parameters**

| Parameter | Type    | Required | Description                           | Example |
| --------- | ------- | -------- | ------------------------------------- | ------- |
| `limit`   | Integer | No       | Number of results, 1-100, default 100 | `100`   |

**Response Example**

```json
{
  "market": "HK",
  "count": 3,
  "data": [
    {
      "symbol": "CP20027.HK",
      "counter_id": "BK/HK/CP20027",
      "name": "Biotech B-shares",
      "chg": "0.0736",
      "intro": "Biotech companies listed under HKEX Chapter 18A"
    }
  ]
}
```

| Field        | Type   | Description          |
| ------------ | ------ | -------------------- |
| `symbol`     | String | Sector code          |
| `counter_id` | String | Sector ID            |
| `name`       | String | Concept name         |
| `chg`        | String | Price change ratio   |
| `intro`      | String | Concept introduction |

***

### Sector Constituents

Get all constituent stocks of a given industry or concept sector, with pagination.

**Endpoint**

* Base path: `/common/v2/basic/plate/members/{plate_symbol}`
* Full path: `https://data.infoway.io/common/v2/basic/plate/members/{plate_symbol}`

**Path Parameters**

| Parameter      | Type   | Required | Description                                                         | Example      |
| -------------- | ------ | -------- | ------------------------------------------------------------------- | ------------ |
| `plate_symbol` | String | Yes      | Sector code, format: `IN{digits}.{market}` or `CP{digits}.{market}` | `IN20293.HK` |

**Query Parameters**

| Parameter | Type    | Required | Description                        | Example |
| --------- | ------- | -------- | ---------------------------------- | ------- |
| `offset`  | Integer | No       | Pagination offset, default 0       | `0`     |
| `limit`   | Integer | No       | Results per page, 1-50, default 50 | `50`    |

**Response Example**

```json
{
  "plate": "IN20293.HK",
  "counter_id": "BK/HK/IN20293",
  "data": {
    "total": 18,
    "offset": 0,
    "limit": 50,
    "members": [
      {"symbol": "1988.HK", "name": "Minsheng Bank", "last_done": "3.870", "chg": "0.0104"},
      {"symbol": "1658.HK", "name": "PSBC", "last_done": "4.960", "chg": "0.0102"},
      {"symbol": "939.HK", "name": "CCB", "last_done": "8.090", "chg": "0.0100"}
    ]
  }
}
```

| Field         | Type    | Description            |
| ------------- | ------- | ---------------------- |
| `total`       | Integer | Total constituents     |
| `offset`      | Integer | Current offset         |
| `limit`       | Integer | Current page size      |
| `members`     | Array   | Constituent stock list |
| `> symbol`    | String  | Symbol code            |
| `> name`      | String  | Stock name             |
| `> last_done` | String  | Latest price           |
| `> chg`       | String  | Price change ratio     |

***

### Industry Introduction

Get AI-generated industry analysis report.

**Endpoint**

* Base path: `/common/v2/basic/plate/intro/{plate_symbol}`
* Full path: `https://data.infoway.io/common/v2/basic/plate/intro/{plate_symbol}`

**Path Parameters**

| Parameter      | Type   | Required | Description | Example      |
| -------------- | ------ | -------- | ----------- | ------------ |
| `plate_symbol` | String | Yes      | Sector code | `IN20293.HK` |

**Response Example**

```json
{
  "plate": "IN20293.HK",
  "intro": "Diversified Banks include large banking institutions providing a wide range of financial services. These banks typically have extensive branch networks in Hong Kong and internationally..."
}
```

| Field   | Type   | Description                    |
| ------- | ------ | ------------------------------ |
| `plate` | String | Sector code                    |
| `intro` | String | AI-generated industry analysis |

***

### Sector Heatmap Chart

Dedicated for frontend rendering of sector heatmaps or bubble distribution charts. It flattens and returns the market weight and market cap of each sector in the market, and can optionally drill down into each sector's constituent stocks.

**Endpoint**

* Base path: `/common/v2/basic/plate/chart/{market}`
* Full path: `https://data.infoway.io/common/v2/basic/plate/chart/{market}`

**Path Parameters**

| Parameter | Type   | Required | Description | Example |
| --------- | ------ | -------- | ----------- | ------- |
| `market`  | String | Yes      | Market code | `CN`    |

**Query Parameters**

| Parameter      | Type    | Required | Description                                                                            | Example |
| -------------- | ------- | -------- | -------------------------------------------------------------------------------------- | ------- |
| `limit`        | Integer | No       | Number of sectors, 1-100, default 50                                                   | `50`    |
| `with_members` | Boolean | No       | Include each sector's constituent stocks (for treemap drill-down), default false       | `true`  |
| `member_limit` | Integer | No       | Max constituents returned per sector, 1-50, default 10 (only when `with_members=true`) | `10`    |

**Response Example**

```json
{
  "market": "CN",
  "count": 1,
  "data": [
    {
      "symbol": "IN40239.SH",
      "counter_id": "BK/SH/IN40239",
      "name": "Diversified Banks",
      "last_done": "1567.65",
      "prev_close": "1569.49",
      "chg": "-0.0012",
      "market_cap": "14554669099556",
      "market_weight": "0.1136",
      "balance": "23587324006",
      "members": [
        {
          "symbol": "601398.SH",
          "name": "ICBC",
          "last_done": "7.90",
          "prev_close": "7.89",
          "chg": "0.0013",
          "market_cap": "2815609431003",
          "this_year_chg": "0.0179",
          "turnover_rate": "0.0011",
          "amplitude": "0.0127",
          "volume_rate": "0.53"
        }
      ]
    }
  ]
}
```

| Field           | Type   | Description                                                        |
| --------------- | ------ | ------------------------------------------------------------------ |
| `symbol`        | String | Sector code                                                        |
| `counter_id`    | String | Internal sector ID                                                 |
| `name`          | String | Sector name                                                        |
| `last_done`     | String | Latest sector index value                                          |
| `prev_close`    | String | Previous close of the sector index                                 |
| `chg`           | String | Overall price change, **a decimal ratio** (`-0.0012` means -0.12%) |
| `market_cap`    | String | Total market capitalization                                        |
| `market_weight` | String | The market weight coefficient of this sector (0-1)                 |
| `balance`       | String | Sector turnover                                                    |
| `members`       | Array  | Constituent stocks, returned only when `with_members=true`         |

**Fields of the `members` array:**

| Field           | Type   | Description                           |
| --------------- | ------ | ------------------------------------- |
| `symbol`        | String | Stock code                            |
| `name`          | String | Stock name                            |
| `last_done`     | String | Latest price                          |
| `prev_close`    | String | Previous close                        |
| `chg`           | String | Price change, decimal ratio           |
| `market_cap`    | String | Market cap (use as treemap tile area) |
| `this_year_chg` | String | Year-to-date change                   |
| `turnover_rate` | String | Turnover rate                         |
| `amplitude`     | String | Amplitude                             |
| `volume_rate`   | String | Volume ratio                          |

> \[!TIP] To render a treemap, use `members[].market_cap` as the tile area and `members[].chg` as the tile colour.