> 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-fundamentals.md).

# GET Symbol Fundamentals

Retrieve essential product data including name, exchange, currency, and shares with the Symbol Basic Information API. Ideal for market analytics and symbol lookup.

### Overview

The **Symbol Fundamentals API** provides metadata for instruments across different asset classes.

* **Equities** (`STOCK_US` / `STOCK_CN` / `STOCK_HK` / `STOCK_IN` / `STOCK_JP` / `STOCK_KS` / `STOCK_TW`) return the full fundamentals set — names, exchange, currency, lot size, share counts, earnings data and board.
* **Non-equity instruments** (`FOREX` / `METAL` / `ENERGY` / `FUTURES` / `INDICES` / `CRYPTO`) return the instrument code, multilingual names and the quote currency. Equity-specific fields do not apply and are always returned as `null`.

See *Response Fields* below for the exact difference between the two sets.

### Endpoint

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

### Request Frequency

This API shares the same rate limits as other endpoints. The number of allowed requests per second depends on your subscription plan. Please refer to the [**Rate Limit**](/en-docs/getting-started/api-limitation.md) for details.

### Error Codes

See the HTTP Error Codes section for reference.

### Authentication

Each request must include your **API Key** in the header.

| **Header** | **Type** | **Required** | **Description**                                 |
| ---------- | -------- | ------------ | ----------------------------------------------- |
| `apiKey`   | String   | Yes          | Your API Key associated with your current plan. |

### Request Parameters

| **Parameter** | **Type** | **Required** | **Description**                                                               | **Example**          |
| ------------- | -------- | ------------ | ----------------------------------------------------------------------------- | -------------------- |
| `type`        | String   | Yes          | Instrument type. See the *Type Reference* table below.                        | `STOCK_US`           |
| `symbols`     | String   | Yes          | Comma-separated list of instrument codes (up to **500 symbols** per request). | `000001.SZ,00076.HK` |

#### Type Reference

| **Type Code** | **Description**  | **Response Set** |
| ------------- | ---------------- | ---------------- |
| `STOCK_US`    | U.S. Stocks      | Equity           |
| `STOCK_CN`    | China A-Shares   | Equity           |
| `STOCK_HK`    | Hong Kong Stocks | Equity           |
| `STOCK_IN`    | India Stocks     | Equity           |
| `STOCK_JP`    | Japan Stocks     | Equity           |
| `STOCK_KS`    | Korea Stocks     | Equity           |
| `STOCK_TW`    | Taiwan Stocks    | Equity           |
| `FUTURES`     | Futures          | Non-equity       |
| `FOREX`       | Foreign Exchange | Non-equity       |
| `ENERGY`      | Energy           | Non-equity       |
| `METAL`       | Metals           | Non-equity       |
| `INDICES`     | Indices          | Non-equity       |
| `CRYPTO`      | Cryptocurrencies | Non-equity       |

**Unsupported types:** any `type` outside the table above (for example `INDEX`) returns HTTP `400` with `msg` set to `not support type`. It does not return `200` with an empty array.

**Futures codes:** `FUTURES` accepts both continuous-contract notations — `CL` and `CL1!` both resolve to the same instrument, and the returned `symbol` matches the notation you sent.

### Example Request

```
GET https://data.infoway.io/common/basic/symbols/info?type=STOCK_CN&symbols=000001.SZ,000002.SZ

```

### Example Response — Equity

```json
{
  "ret": 200,
  "msg": "success",
  "traceId": "52327ed3-e96a-4e9a-a591-e910a0fcc563",
  "data": [
    {
      "symbol": "000001.SZ",
      "market": "CN",
      "name_cn": "平安银行",
      "name_en": "PAB",
      "name_hk": "平安銀行",
      "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",
      "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"
    }
  ]
}
```

### Example Response — Non-equity

```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": "",
      "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
    }
  ]
}
```

### Response Fields

The JSON shape is identical for every type; only the populated fields differ.

#### Equity Fields

Applies to `STOCK_US` / `STOCK_CN` / `STOCK_HK` / `STOCK_IN` / `STOCK_JP` / `STOCK_KS` / `STOCK_TW`.

| **Field**            | **Type** | **Required** | **Description**                                                                  | **Example / Values**                                         |
| -------------------- | -------- | ------------ | -------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `symbol`             | `string` | Yes          | Instrument code.                                                                 | `AAPL.US`                                                    |
| `market`             | `string` | No           | Market the instrument belongs to.                                                | `US`, `CN`, `HK`, `IN`, `JP`, `KS`, `TW`                     |
| `name_cn`            | `string` | No           | Simplified Chinese name.                                                         | `苹果`                                                         |
| `name_en`            | `string` | No           | English name.                                                                    | `Apple`                                                      |
| `name_hk`            | `string` | No           | Traditional Chinese name.                                                        | `蘋果`                                                         |
| `exchange`           | `string` | No           | Trading exchange where the instrument is listed.                                 | `NASD`, `SSE`, `SZSE`, `SEHK`, `NYSE`, `AMEX`, `OTC`, `NYSD` |
| `currency`           | `string` | No           | Trading currency.                                                                | `USD`, `CNY`, `HKD`, `EUR`, `SGD`, `JPY`, `AUD`, `GBP`       |
| `lot_size`           | `int32`  | No           | Lot size (number of shares per trade lot).                                       | `100`                                                        |
| `total_shares`       | `int64`  | No           | Total outstanding shares.                                                        | `1000000000`                                                 |
| `circulating_shares` | `int64`  | No           | Shares available for public trading.                                             | `800000000`                                                  |
| `hk_shares`          | `int64`  | No           | Hong Kong–listed share count (for HK stocks only).                               | `500000000`                                                  |
| `eps`                | `string` | No           | Earnings per share.                                                              | `5.25`                                                       |
| `eps_ttm`            | `string` | No           | Trailing twelve-month (TTM) earnings per share.                                  | `5.50`                                                       |
| `bps`                | `string` | No           | Book value per share.                                                            | `120.50`                                                     |
| `dividend_yield`     | `string` | No           | Dividend yield (percentage).                                                     | `3.5`                                                        |
| `board`              | `string` | No           | The board or trading segment the symbol belongs to. See *Board Reference* below. | `SZMainConnect`                                              |

#### Non-equity Fields

Applies to `FOREX` / `METAL` / `ENERGY` / `FUTURES` / `INDICES` / `CRYPTO`.

| **Field**  | **Type** | **Required** | **Description**                                                                     | **Example / Values**      |
| ---------- | -------- | ------------ | ----------------------------------------------------------------------------------- | ------------------------- |
| `symbol`   | `string` | Yes          | Instrument code.                                                                    | `EURUSD`, `CL`, `BTCUSDT` |
| `name_cn`  | `string` | No           | Simplified Chinese name.                                                            | `欧元/美元`                   |
| `name_en`  | `string` | No           | English name.                                                                       | `Euro / U.S. Dollar`      |
| `name_hk`  | `string` | No           | Traditional Chinese name; returns an empty string when not yet available.           | `黃金現貨 / 美元`               |
| `currency` | `string` | No           | Quote currency. A small number of indices have no quote currency and return `null`. | `USD`, `USDT`             |

Every other field (`market`, `lot_size`, `total_shares`, `circulating_shares`, `hk_shares`, `eps`, `eps_ttm`, `bps`, `dividend_yield`, `stock_derivatives`, `board`) is equity-specific, does not apply to non-equity instruments, and is always returned as `null`.

`exchange` is also always `null` for non-equity instruments: the listing venue is not exposed for these asset classes. This is by design, not missing data.

### Board Reference

| **Board Code**     | **Description**                         |
| ------------------ | --------------------------------------- |
| `USMain`           | U.S. Main Board                         |
| `USPink`           | U.S. OTC / Pink Sheets                  |
| `USDJI`            | Dow Jones Index                         |
| `USNSDQ`           | NASDAQ Index                            |
| `USSector`         | U.S. Sector & Industry                  |
| `USOption`         | U.S. Options                            |
| `USOptionS`        | U.S. Special Options (Close at 16:15)   |
| `HKEquity`         | Hong Kong Equity                        |
| `HKPreIPO`         | Hong Kong Pre-IPO Market                |
| `HKWarrant`        | Hong Kong Warrants                      |
| `HKHS`             | Hang Seng Index                         |
| `HKSector`         | Hong Kong Sector & Industry             |
| `SHMainConnect`    | Shanghai Main Board – Connect           |
| `SHMainNonConnect` | Shanghai Main Board – Non-Connect       |
| `SHSTAR`           | STAR Market (Sci-Tech Innovation Board) |
| `CNIX`             | Mainland China Index                    |
| `CNSector`         | Mainland China Sector & Industry        |
| `SZMainConnect`    | Shenzhen Main Board – Connect           |
| `SZMainNonConnect` | Shenzhen Main Board – Non-Connect       |
| `SZGEMConnect`     | ChiNext Board – Connect                 |
| `SZGEMNonConnect`  | ChiNext Board – Non-Connect             |