> 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/rest-api/basic-info/get-symbol-basic-info.md).

# GET获取产品的基础信息

## 接口说明

该接口用于获取标的的基础信息。

* **股票类**（`STOCK_US` / `STOCK_CN` / `STOCK_HK` / `STOCK_IN` / `STOCK_JP` / `STOCK_KS` / `STOCK_TW`）：返回名称、交易所、币种、每手股数、股本、每股盈利、所属板块等完整基础数据。
* **非股票类**（`FOREX` / `METAL` / `ENERGY` / `FUTURES` / `INDICES` / `CRYPTO`）：返回标的代码、多语言名称与计价货币；股票专用字段对其不适用，固定返回 `null`。

两类的出参差异见下方「返回字段说明」。

## 请求频率

跟其他接口请求频率使用同一个频率限制。具体每秒请求次数根据套餐决定。可以参考[接口限制说明](/getting-started/api-limitation.md)

## 错误码说明

参考HTTP错误码说明

## 接口地址

* 基本路径：`/common/basic/symbols/info`
* 完整路径：`https://data.infoway.io/common/basic/symbols/info`

## 请求头

| 参数       | 类型     | 必填 | 描述           |
| -------- | ------ | -- | ------------ |
| `apiKey` | String | 是  | 您套餐中的API Key |

## Request param入参说明

| 参数名       | 类型     | 必填 | 描述                                               | 示例值                  |
| --------- | ------ | -- | ------------------------------------------------ | -------------------- |
| `type`    | String | 是  | 标的类型，参考下面<mark style="color:blue;">type类型</mark> | `STOCK_US`           |
| `symbols` | String | 是  | 标的列表，多个用,隔开，最大支持500个                             | `000001.SZ,00076.HK` |

#### Type说明

| 类型代码       | 描述   | 出参类型 |
| ---------- | ---- | ---- |
| `STOCK_US` | 美股   | 股票类  |
| `STOCK_CN` | A股   | 股票类  |
| `STOCK_HK` | 港股   | 股票类  |
| `STOCK_IN` | 印股   | 股票类  |
| `STOCK_JP` | 日股   | 股票类  |
| `STOCK_KS` | 韩股   | 股票类  |
| `STOCK_TW` | 台股   | 股票类  |
| `FUTURES`  | 期货   | 非股票类 |
| `FOREX`    | 外汇   | 非股票类 |
| `ENERGY`   | 能源   | 非股票类 |
| `METAL`    | 金属   | 非股票类 |
| `INDICES`  | 指数   | 非股票类 |
| `CRYPTO`   | 加密货币 | 非股票类 |

**不支持的类型**：传入上表以外的 `type`（例如 `INDEX`）返回 HTTP `400`，`msg` 为 `not support type`，不会返回 `200` + 空数组。

**期货代码写法**：`FUTURES` 支持主连代码的两种写法，`CL` 与 `CL1!` 均可查询，出参 `symbol` 与您传入的写法保持一致。

## 返回示例

### 股票类

```json
{
  "ret": 200,
  "msg": "success",
  "traceId": "52327ed3-e96a-4e9a-a591-e910a0fcc563",
  "data": [
    {
      "symbol": "000001.SZ",
      "market": "CN",
      "name_cn": "平安银行",
      "name_en": "PAB",
      "name_hk": "平安銀行",
      "name_local": "",
      "exchange": "SZSE",
      "currency": "CNY",
      "lot_size": 100,
      "total_shares": 19405918198,
      "circulating_shares": 19405762053,
      "hk_shares": 0,
      "eps": "2.2935271367158012",
      "eps_ttm": "2.2504474951615995",
      "bps": "22.4755662447835698",
      "dividend_yield": "0.9649999999963929",
      "stock_derivatives": "",
      "board": "SZMainConnect"
    },
    {
      "symbol": "000002.SZ",
      "market": "CN",
      "name_cn": "万科A",
      "name_en": "Vanke",
      "name_hk": "萬科A",
      "name_local": "",
      "exchange": "SZSE",
      "currency": "CNY",
      "lot_size": 100,
      "total_shares": 11930709471,
      "circulating_shares": 9724196533,
      "hk_shares": 0,
      "eps": "-4.147148946357911",
      "eps_ttm": "-4.6403502137102706",
      "bps": "16.4892858366243256",
      "dividend_yield": "0",
      "stock_derivatives": "",
      "board": "SZMainConnect"
    }
  ]
}
```

### 非股票类

```json
{
  "ret": 200,
  "msg": "success",
  "traceId": "0276f93d-cc3c-43cd-9fdc-e3bad01e2a85",
  "data": [
    {
      "symbol": "EURUSD",
      "market": null,
      "name_cn": "欧元/美元",
      "name_en": "Euro / U.S. Dollar",
      "name_hk": "",
      "name_local": "",
      "exchange": null,
      "currency": "USD",
      "lot_size": null,
      "total_shares": null,
      "circulating_shares": null,
      "hk_shares": null,
      "eps": null,
      "eps_ttm": null,
      "bps": null,
      "dividend_yield": null,
      "stock_derivatives": null,
      "board": null
    }
  ]
}
```

## 返回字段说明

出参结构对所有类型一致，区别在于哪些字段有值。

### 股票类返回字段

适用于 `STOCK_US` / `STOCK_CN` / `STOCK_HK` / `STOCK_IN` / `STOCK_JP` / `STOCK_KS` / `STOCK_TW`。

| 字段名                  | 类型     | 必填 | 描述                                                  | 示例值/可选值                                                      |
| -------------------- | ------ | -- | --------------------------------------------------- | ------------------------------------------------------------ |
| `symbol`             | string | 是  | 标的代码                                                | `AAPL.US`                                                    |
| `market`             | string | 否  | 标的所属市场                                              | `US`, `CN`, `HK`, `IN`, `JP`, `KS`, `TW`                     |
| `name_cn`            | string | 否  | 中文简体标的名称                                            | `苹果`                                                         |
| `name_en`            | string | 否  | 英文标的名称                                              | `Apple`                                                      |
| `name_hk`            | string | 否  | 中文繁体标的名称                                            | `蘋果`                                                         |
| `name_local`         | string | 否  | 标的当地语言名称：JP=日文、KR=韩文、TW=繁体中文、IN=英文；US/CN/HK 与非股票类为空 | `トヨタ自動車`                                                     |
| `exchange`           | string | 否  | 标的所属交易所                                             | `NASD`, `SSE`, `SZSE`, `SEHK`, `NYSE`, `AMEX`, `OTC`, `NYSD` |
| `currency`           | string | 否  | 交易币种                                                | `USD`, `CNY`, `HKD`, `EUR`, `SGD`, `JPY`, `AUD`, `GBP`       |
| `lot_size`           | int32  | 否  | 每手股数                                                | `100`                                                        |
| `total_shares`       | int64  | 否  | 总股本                                                 | `1000000000`                                                 |
| `circulating_shares` | int64  | 否  | 流通股本                                                | `800000000`                                                  |
| `hk_shares`          | int64  | 否  | 港股股本 (仅港股)                                          | `500000000`                                                  |
| `eps`                | string | 否  | 每股盈利                                                | `5.25`                                                       |
| `eps_ttm`            | string | 否  | 每股盈利 (TTM)                                          | `5.50`                                                       |
| `bps`                | string | 否  | 每股净资产                                               | `120.50`                                                     |
| `dividend_yield`     | string | 否  | 股息                                                  | `3.5`                                                        |
| `board`              | string | 否  | 标的所属板块                                              | 参考下面的说明                                                      |

### 非股票类返回字段

适用于 `FOREX` / `METAL` / `ENERGY` / `FUTURES` / `INDICES` / `CRYPTO`。

| 字段名          | 类型     | 必填 | 描述                        | 示例值/可选值                   |
| ------------ | ------ | -- | ------------------------- | ------------------------- |
| `symbol`     | string | 是  | 标的代码                      | `EURUSD`, `CL`, `BTCUSDT` |
| `name_cn`    | string | 否  | 中文简体标的名称                  | `欧元/美元`                   |
| `name_en`    | string | 否  | 英文标的名称                    | `Euro / U.S. Dollar`      |
| `name_hk`    | string | 否  | 中文繁体标的名称；暂缺时返回空字符串        | `黃金現貨 / 美元`               |
| `name_local` | string | 否  | 标的当地语言名称；非股票类恒为空字符串       | `""`                      |
| `currency`   | string | 否  | 计价货币；少数指数暂无计价货币，返回 `null` | `USD`, `USDT`             |

以上五个字段之外的其余字段（`market`、`lot_size`、`total_shares`、`circulating_shares`、`hk_shares`、`eps`、`eps_ttm`、`bps`、`dividend_yield`、`stock_derivatives`、`board`）为股票专用，对非股票类标的不适用，固定返回 `null`。

`exchange` 同样固定返回 `null`：非股票类标的的挂牌交易所暂不对外提供，属产品约定而非数据缺失。

### Board

| 板块代码               | 描述                  |
| ------------------ | ------------------- |
| `USMain`           | 美股主板                |
| `USPink`           | 粉单市场                |
| `USDJI`            | 道琼斯指数               |
| `USNSDQ`           | 纳斯达克指数              |
| `USSector`         | 美股行业概念              |
| `USOption`         | 美股期权                |
| `USOptionS`        | 美股特殊期权（收盘时间为 16:15） |
| `HKEquity`         | 港股股本证券              |
| `HKPreIPO`         | 港股暗盘                |
| `HKWarrant`        | 港股轮证                |
| `HKHS`             | 恒生指数                |
| `HKSector`         | 港股行业概念              |
| `SHMainConnect`    | 上证主板 - 互联互通         |
| `SHMainNonConnect` | 上证主板 - 非互联互通        |
| `SHSTAR`           | 科创板                 |
| `CNIX`             | 沪深指数                |
| `CNSector`         | 沪深行业概念              |
| `SZMainConnect`    | 深证主板 - 互联互通         |
| `SZMainNonConnect` | 深证主板 - 非互联互通        |
| `SZGEMConnect`     | 创业板 - 互联互通          |
| `SZGEMNonConnect`  | 创业板 - 非互联互通         |
