> 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-symbol-list.md).

# GET Symbol List

The Symbol List API allows you to retrieve the full list of available trading instruments across different markets.

List instruments in a market, with optional symbol filters.

### Overview

Use this to confirm coverage before requesting quotes. List `type` values are not the same as quote suffixes. See Symbol convention.

### Request frequency

Shares the same HTTP [rate limits](/en-docs/getting-started/api-limitation/rest-api-limitation.md) as other REST endpoints.

### Error codes

See [REST API Error Codes](/en-docs/getting-started/error-codes/rest-api-error-codes.md). Missing `type` is typically HTTP 400: `Required parameter 'type' is not present.`

### Endpoint

* Base path: `/common/basic/symbols`
* Full path: `https://data.infoway.io/common/basic/symbols`

### Authentication

| Header   | Type   | Required | Description  |
| -------- | ------ | -------- | ------------ |
| `apiKey` | String | Yes      | Plan API key |

### Parameters

| Parameter | Type   | Required | Description                                                                  | Example            |
| --------- | ------ | -------- | ---------------------------------------------------------------------------- | ------------------ |
| `type`    | String | Yes      | Instrument type from the table below. Do not pass a market code such as `US` | `STOCK_US`         |
| `symbols` | String | No       | Comma-separated symbols                                                      | `.DJI.US,.IXIC.US` |

#### Type reference

| Type       | Meaning                                                         |
| ---------- | --------------------------------------------------------------- |
| `STOCK_US` | US equities                                                     |
| `STOCK_CN` | China A-shares (list type only; quotes still use `.SH` / `.SZ`) |
| `STOCK_HK` | Hong Kong                                                       |
| `FUTURES`  | Futures                                                         |
| `FOREX`    | FX                                                              |
| `ENERGY`   | Energy                                                          |
| `METAL`    | Metals                                                          |
| `CRYPTO`   | Crypto                                                          |
| `STOCK_IN` | India                                                           |
| `STOCK_JP` | Japan                                                           |
| `STOCK_KS` | Korea                                                           |
| `STOCK_TW` | Taiwan                                                          |
| `INDICES`  | Indices                                                         |

### Example response

```json
{
  "ret": 200,
  "msg": "success",
  "traceId": "ed8a84d9-4575-4077-bc1c-31b17d0c8977",
  "data": [
    {
      "symbol": ".DJI.US",
      "name_cn": "道琼斯指数",
      "name_hk": "道瓊斯指數",
      "name_en": "Dow Jones Industrial Average",
      "name_local": "",
      "index": true
    }
  ]
}
```

| Field        | Type    | Required | Description                                                                  | Example      |
| ------------ | ------- | -------- | ---------------------------------------------------------------------------- | ------------ |
| `symbol`     | String  | Yes      | Instrument code                                                              | `AAPL.US`    |
| `name_cn`    | String  | No       | Simplified Chinese name                                                      | `苹果`         |
| `name_hk`    | String  | No       | Traditional Chinese name                                                     | `蘋果`         |
| `name_en`    | String  | No       | English name                                                                 | `Apple Inc.` |
| `name_local` | String  | No       | Name in the local-market language (JP/KS/TW/IN stocks only; empty otherwise) | `トヨタ自動車`     |
| `index`      | Boolean | No       | Whether the row is an index                                                  | `true`       |

### Notes

* `type=STOCK_CN` only means “A-share list”. Quotes must use `600519.SH` / `000001.SZ`, never `.CN`.
* Hong Kong codes must be 5 digits: `00700.HK`. `700.HK` fails.
* Cache the list; do not pull the full universe on every request.