> 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-stock-detail-data.md).

# GET Stock Detail Data

## Overview

Retrieve detailed information for a specific stock, including name, exchange, currency, shares, logo, company profile, and more.

### Endpoint

* Base Path: `/common/basic/stock/detail`
* Full Path: `https://data.infoway.io/common/basic/stock/detail`

### 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/rest-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      | Instrument type (see type table below) | `STOCK_CN`  |
| `symbol`  | String | Yes      | Instrument code                        | `000001.SZ` |

### Type Values

| Code       | Description      |
| ---------- | ---------------- |
| `STOCK_US` | US Stocks        |
| `STOCK_CN` | China A-Shares   |
| `STOCK_HK` | Hong Kong Stocks |
| `STOCK_IN` | India Stocks     |
| `STOCK_JP` | Japan Stocks     |
| `STOCK_KS` | Korea Stocks     |

## Response Example

```json
{
    "ret": 200,
    "msg": "success",
    "traceId": "43b4d6df-708e-4a07-b550-e2455608c23c",
    "data": {
        "symbol": "1STCUS.IN",
        "market": "IN",
        "name_cn": "",
        "name_en": "First Custodian Fund India Ltd.",
        "name_hk": "",
        "exchange": "BSE",
        "currency": "INR",
        "lot_size": null,
        "total_shares": null,
        "circulating_shares": null,
        "hk_shares": null,
        "eps": "-1.438",
        "eps_ttm": null,
        "bps": null,
        "dividend_yield": "0.0123563573458544",
        "stock_derivatives": null,
        "board": "Finance",
        "sector": "Finance",
        "curr_logo": "https://logo.infoway.io/logos/country/IN.svg",
        "exc_logo": "https://logo.infoway.io/logos/exchange/bse.svg",
        "logo": "https://logo.infoway.io/logos/stock/fi/first-custodian-fund-india-l.svg",
        "market_cap": 114270000.00,
        "figi_composite": "BBG000CR6526",
        "figi_exchange": "BBG000CR5S8",
        "isin": "INE609B01018",
        "ceo": "Giriraj Kumar Dammani",
        "total_employees": 6,
        "founded": 1985,
        "website": "http://firstcustodianfund.in",
        "headquarters": "Mumbai",
        "industry": "Investment Banks/Brokers",
        "has_bonds": 0
    }
}
```

## Response Fields

| Field                | Type       | Required | Description                                    | Example / Values                                             |
| -------------------- | ---------- | -------- | ---------------------------------------------- | ------------------------------------------------------------ |
| `symbol`             | String     | Yes      | Instrument code                                | `AAPL.US`                                                    |
| `name_cn`            | String     | No       | Name in Simplified Chinese                     | `苹果`                                                         |
| `name_en`            | String     | No       | Name in English                                | `Apple`                                                      |
| `name_hk`            | String     | No       | Name in Traditional Chinese                    | `蘋果`                                                         |
| `exchange`           | String     | No       | Listing exchange                               | `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       | Shares per lot                                 | `100`                                                        |
| `total_shares`       | int64      | No       | Total shares outstanding                       | `1000000000`                                                 |
| `circulating_shares` | int64      | No       | Circulating shares                             | `800000000`                                                  |
| `hk_shares`          | int64      | No       | Hong Kong shares (HK stocks only)              | `500000000`                                                  |
| `eps`                | String     | No       | Earnings per share                             | `5.25`                                                       |
| `eps_ttm`            | String     | No       | Earnings per share (TTM)                       | `5.50`                                                       |
| `bps`                | String     | No       | Book value per share                           | `120.50`                                                     |
| `dividend_yield`     | String     | No       | Dividend yield                                 | `3.5`                                                        |
| `stock_derivatives`  | int32\[]   | No       | Available derivative types                     | `[1, 2]` (1 = Options, 2 = Warrants & CBBCs)                 |
| `board`              | String     | No       | Board/segment classification                   | See Board table below                                        |
| `sector`             | String     | No       | Sector classification                          |                                                              |
| `curr_logo`          | String     | No       | Country flag logo URL                          |                                                              |
| `exc_logo`           | String     | No       | Exchange logo URL                              |                                                              |
| `logo`               | String     | No       | Company logo URL                               |                                                              |
| `market_cap`         | BigDecimal | No       | Market capitalization                          |                                                              |
| `figi_composite`     | String     | No       | FIGI composite identifier                      |                                                              |
| `figi_exchange`      | String     | No       | Exchange-level FIGI identifier                 |                                                              |
| `isin`               | String     | No       | International Securities Identification Number |                                                              |
| `ceo`                | String     | No       | Chief Executive Officer                        |                                                              |
| `total_employees`    | int64      | No       | Total number of employees                      |                                                              |
| `founded`            | String     | No       | Year founded                                   |                                                              |
| `website`            | String     | No       | Company website URL                            |                                                              |
| `headquarters`       | String     | No       | Headquarters location                          |                                                              |
| `industry`           | String     | No       | Industry classification                        |                                                              |
| `has_bonds`          | String     | No       | Whether bonds are available                    |                                                              |

## Board Classification

| Code               | Description                             |
| ------------------ | --------------------------------------- |
| `USMain`           | US Main Board                           |
| `USPink`           | US Pink Sheets (OTC)                    |
| `USDJI`            | Dow Jones Industrial Average            |
| `USNSDQ`           | NASDAQ Composite                        |
| `USSector`         | US Sector/Concept                       |
| `USOption`         | US Options                              |
| `USOptionS`        | US Special Options (close at 16:15)     |
| `HKEquity`         | HK Equities                             |
| `HKPreIPO`         | HK Pre-IPO (Grey Market)                |
| `HKWarrant`        | HK Warrants & CBBCs                     |
| `HKHS`             | Hang Seng Index                         |
| `HKSector`         | HK Sector/Concept                       |
| `SHMainConnect`    | Shanghai Main Board - Stock Connect     |
| `SHMainNonConnect` | Shanghai Main Board - Non-Connect       |
| `SHSTAR`           | STAR Market (Sci-Tech Innovation Board) |
| `CNIX`             | China Indices                           |
| `CNSector`         | China Sector/Concept                    |
| `SZMainConnect`    | Shenzhen Main Board - Stock Connect     |
| `SZMainNonConnect` | Shenzhen Main Board - Non-Connect       |
| `SZGEMConnect`     | ChiNext (GEM) - Stock Connect           |
| `SZGEMNonConnect`  | ChiNext (GEM) - Non-Connect             |