> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tqx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Stock details

> Retrieve reference information for listed stocks.

## Get detailed information of stocks

### Method name: get\_stock\_detail

### Enter parameters

| **Field** | **Type**                           | **Description**                                                      | **Is it required** |
| :-------- | :--------------------------------- | :------------------------------------------------------------------- | :----------------- |
| symbol    | Optional\[Union\[str, List\[str]]] | Stock code                                                           | Optional           |
| fields    | Optional\[Union\[str, List\[str]]] | Return fields                                                        | Optional           |
| market    | Optional\[str]                     | Market, supports hk, us, default hk                                  | Optional           |
| status    | Optional\[int]                     | Whether in the market, 1 - in the market, 0 - delisted, -1 - unknown | Optional           |

### Response parameters

#### hk corresponding parameters

| Field                      | Type | Description                                  |
| :------------------------- | :--- | :------------------------------------------- |
| symbol                     | str  | stock code                                   |
| name                       | str  | stock name                                   |
| cn\_name                   | str  | Chinese name                                 |
| local\_name                | str  | local organization name                      |
| status                     | int  | stock status                                 |
| isin\_code                 | str  | International Securities Identification Code |
| abbrev\_symbol             | str  | Stock abbreviation                           |
| min\_order\_amount         | str  | How many shares corresponds to one lot       |
| trading\_code              | str  | trading code                                 |
| asset\_state               | str  | transaction status                           |
| rcs\_asset\_category\_name | str  | asset category name                          |
| business\_sector           | str  | Business sector name                         |
| economic\_sector           | str  | Economic sector name                         |
| industry\_group            | str  | Industry group name                          |
| incorp\_date               | str  | company incorporation date                   |
| office\_address            | str  | Company headquarters address                 |
| office\_city               | str  | Headquarters city                            |
| office\_country            | str  | Headquarters country                         |
| office\_region             | str  | Headquarters region                          |
| postal\_code               | str  | Headquarters postal code                     |
| website                    | str  | company website                              |
| listed\_date               | str  | listing date                                 |

#### us corresponding parameters

| Field                      | Type | Description                                  |
| :------------------------- | :--- | :------------------------------------------- |
| symbol                     | str  | stock code                                   |
| original\_symbol           | str  | original stock symbol                        |
| name                       | str  | stock name                                   |
| listed\_date               | str  | listing date                                 |
| local\_name                | str  | local organization name                      |
| exchange\_name             | str  | exchange name                                |
| status                     | int  | stock status                                 |
| isin\_code                 | str  | International Securities Identification Code |
| abbrev\_symbol             | str  | Stock abbreviation                           |
| min\_order\_amount         | str  | How many shares corresponds to one lot       |
| trading\_code              | str  | trading code                                 |
| asset\_state               | str  | transaction status                           |
| rcs\_asset\_category\_name | str  | asset category name                          |
| business\_sector           | str  | Business sector name                         |
| economic\_sector           | str  | Economic sector name                         |
| industry\_group            | str  | Industry group name                          |
| incorp\_date               | str  | company incorporation date                   |
| office\_address            | str  | Company headquarters address                 |
| office\_city               | str  | Headquarters city                            |
| office\_country            | str  | Headquarters country                         |
| office\_region             | str  | Headquarters region                          |
| postal\_code               | str  | Headquarters postal code                     |
| website                    | str  | company website                              |

### Usage examples

#### Hong Kong stocks

```python theme={null}
import tqx_data
result = tqx_data.get_stock_detail(
    symbol=["0001.HK","0002.HK","0003.HK"],
    market="hk",
    fields=[""],
    status=None
)
print(result)
```

**Response Example**

```text theme={null}
symbol abbrev_symbol ... status trading_code
0 0001.HK CKHUH ... 1 0001
1 0002.HK CLPHL ... 1 0002
2 0003.HK HKCNG ... 1 0003|864603
```

#### US stocks

```python theme={null}
import tqx_data
result = tqx_data.get_stock_detail(
    symbol=["0013.NB", "005490.NB", "ZYXIQ.NB"],
    market="us",
    fields=[""],
    status=None
)
print(result)
```

**Response Example**

```text theme={null}
symbol abbrev_symbol ... status trading_code
0 0013.NB None ... 1 None
1 005490.NB POSCO ... 1 893094
2 ZYXIQ.NB ZYXIQ ... 0 None
```

#### Get all Hong Kong stock codes

```python theme={null}
import tqx_data
result = tqx_data.get_stock_detail(
    symbol="",
    fields=["symbol"],
    market="hk",
    status=None
)
print(result)
```

**Response Example**

```text theme={null}
symbol
0 0001.HK
1 0002.HK
2 0003.HK
3 0004.HK
4 0005.HK
... ...
3224 SPFH.HK
3225 SUFH.HK
3226 TEXH.HK
3227 TTFH.HK
3228 UNTX.HK
```

#### Get all US stock codes

```python theme={null}
import tqx_data
result = tqx_data.get_stock_detail(
    symbol="",
    fields=["symbol"],
    market="us",
    status=None
)
print(result)
```

**Response Example**

```text theme={null}
symbol
0 0013.NB
1 005490.NB
2 015760.NB
3 017670.NB
4 030200.NB
... ...
7792 ZXZZT.NB
7793 ZYBT.NB
7794 ZYME.NB
7795 ZYRX.NB
7796 ZYXIQ.NB
```