# GET Symbol Fundamentals

### Overview

The **Symbol Fundamentals API** provides detailed metadata for instruments across different markets — including names, exchange, currency, lot size, share information, earnings data, and more.\
This endpoint helps developers obtain the foundational attributes of each product before requesting market data or performing analytics.

### 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](/en-docs/getting-started/error-codes/rest-api-error-codes.md) 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          | Market 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

| `STOCK_US` | U.S. Stocks      |
| ---------- | ---------------- |
| `STOCK_CN` | China A-Shares   |
| `STOCK_HK` | Hong Kong Stocks |
| `FUTURES`  | Futures          |
| `FOREX`    | Foreign Exchange |
| `ENERGY`   | Energy           |
| `METAL`    | Metals           |
| `CRYPTO`   | Cryptocurrencies |
| `STOCK_IN` | India Stocks     |
| `STOCK_JP` | Japan Stocks     |

### Example Request

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

```

### Example Response

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

### Response Fields

| **Field**            | **Type**  | **Required** | **Description**                                                                                                     | **Example / Values**                                         |
| -------------------- | --------- | ------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `symbol`             | `string`  | Yes          | Instrument code.                                                                                                    | `AAPL.US`                                                    |
| `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`                                                        |
| `stock_derivatives`  | `int32[]` | No           | <p>Available derivative data types.<br><code>\[1, 2]</code> → <code>1</code>: Options, <code>2</code>: Warrants</p> | `[1, 2]`                                                     |
| `board`              | `string`  | No           | The board or trading segment the symbol belongs to. See *Board Reference* below.                                    | `SZMainConnect`                                              |

### 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             |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.infoway.io/en-docs/rest-api/get-basic-info/get-symbol-fundamentals.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.