Pytdx

https://pytdx-docs.readthedocs.io/zh-cn/latest
Admin
Pytdx is a pure Python implementation of a TradeX-like market data interface that provides quote...
Tokens:36,318
Snippets:251
Trust Score:8.3
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install pytdx via pip

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/

Install the pytdx package using pip. This is the standard installation command for the library.

```bash
pip install pytdx
```

--------------------------------

### api.get_security_list(market, start)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

获取股票列表。参数：市场代码，起始位置。

```APIDOC
## api.get_security_list(market, start)

### Description
获取股票列表。参数：市场代码，起始位置。

### Method
get_security_list

### Endpoint
api.get_security_list(market, start)

### Parameters
- **market** (int) - Required - 市场代码：0 深圳，1 上海
- **start** (int) - Required - 起始位置，如 0 或 100

### Request Example
```python
api.get_security_list(1, 0)
```

### Response
#### Success Response
- 返回 list 结构，包含股票列表

#### Response Example
```python
[{'code': '600000', 'name': '浦发银行', ...}, ...]
```
```

--------------------------------

### api.get_index_bars(category, market, stockcode, start, count)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

获取指数K线数据。参数与 get_security_bars 类似。

```APIDOC
## api.get_index_bars(category, market, stockcode, start, count)

### Description
获取指数K线数据。参数与 get_security_bars 类似。

### Method
get_index_bars

### Endpoint
api.get_index_bars(category, market, stockcode, start, count)

### Parameters
- **category** (int) - Required - K线种类：0 5分钟K线, 1 15分钟K线, 2 30分钟K线, 3 1小时K线, 4 日K线, 5 周K线, 6 月K线, 7 1分钟, 8 1分钟K线, 9 日K线, 10 季K线, 11 年K线
- **market** (int) - Required - 市场代码：0 深圳，1 上海
- **stockcode** (string) - Required - 证券代码
- **start** (int) - Required - 指定的范围开始位置
- **count** (int) - Required - 用户要请求的K线数目，最大值为800

### Request Example
```python
api.get_index_bars(9, 1, '000001', 1, 2)
```

### Response
#### Success Response
- 返回 list 结构，包含指数K线数据

#### Response Example
```python
[{'open': 3000.0, 'close': 3005.0, ...}, ...]
```
```

--------------------------------

### 从GitHub克隆并安装pytdx

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/installation/

使用git clone和python setup.py install从GitHub安装pytdx。

```bash
> git clone https://github.com/rainx/pytdx.git
> cd pytdx
> python setup.py install
```

--------------------------------

### 查询分笔成交

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

查询指定市场ID和证券代码的分笔成交数据。注意，该接口最多返回1800条记录，如有超过1800条记录的请求，可使用 start 参数作为偏移量。

```APIDOC
## 查询分笔成交

### Description
查询指定市场ID和证券代码的分笔成交数据。注意，该接口最多返回1800条记录，如有超过1800条记录的请求，可使用 start 参数作为偏移量。

### Method
get_transaction_data

### Endpoint
api.get_transaction_data(market, code, start=0)

### Parameters
#### Path Parameters
- **market** (int) - Required - 市场ID，可通过 get_markets 获得
- **code** (string) - Required - 证券代码
- **start** (int) - Optional - 偏移量，默认0，用于获取超过1800条记录

### Request Example
```python
api.get_transaction_data(31, "00020")
```

### Response
#### Success Response
- 返回分笔成交数据，最多1800条
```

--------------------------------

### 登入

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

调用api.logon()进行登录，成功后获取client_id。

```python
result = api.logon(ip, port, version, yyb_id, account_id, trade_account, jy_passwrod, tx_password)
if result["success"]:
    client_id = result["data"]["client_id"]
```

--------------------------------

### 查询历史分笔成交（带偏移量）

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

调用 get_history_transaction_data 并传入市场ID、证券代码、日期和 start 参数，用于获取超过1800条记录的历史数据。

```python
api.get_history_transaction_data(47, "IFL0", 20170810, start=1800)
```

--------------------------------

### api.connect(ip, port)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

连接行情服务器。成功返回 True，失败返回 False。支持 with 语法自动断开连接。

```APIDOC
## api.connect(ip, port)

### Description
连接行情服务器。成功返回 True，失败返回 False。支持 with 语法自动断开连接。

### Method
connect

### Endpoint
api.connect(ip, port)

### Parameters
- **ip** (string) - Required - 服务器 IP 地址
- **port** (int) - Required - 服务器端口号

### Request Example
```python
api.connect('119.147.212.81', 7709)
```

### Response
#### Success Response
- 连接成功返回 True，失败返回 False

#### Response Example
```python
True
```
```

--------------------------------

### api.get_transaction_data(market, stockcode, start, count)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

查询分笔成交。参数：市场代码，股票代码，起始位置，数量。

```APIDOC
## api.get_transaction_data(market, stockcode, start, count)

### Description
查询分笔成交。参数：市场代码，股票代码，起始位置，数量。

### Method
get_transaction_data

### Endpoint
api.get_transaction_data(market, stockcode, start, count)

### Parameters
- **market** (int) - Required - 市场代码：0 深圳，1 上海，可使用 TDXParams.MARKET_SZ 等常量
- **stockcode** (string) - Required - 股票代码
- **start** (int) - Required - 起始位置
- **count** (int) - Required - 数量

### Request Example
```python
api.get_transaction_data(TDXParams.MARKET_SZ, '000001', 0, 30)
```

### Response
#### Success Response
- 返回 list 结构，包含分笔成交数据

#### Response Example
```python
[{'time': '09:30', 'price': 10.0, 'volume': 100, ...}, ...]
```
```

--------------------------------

### api.get_company_info_content(market, stockcode, filename, start, count)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

读取公司信息详情。参数：市场代码，股票代码，文件名，起始位置，数量。

```APIDOC
## api.get_company_info_content(market, stockcode, filename, start, count)

### Description
读取公司信息详情。参数：市场代码，股票代码，文件名，起始位置，数量。

### Method
get_company_info_content

### Endpoint
api.get_company_info_content(market, stockcode, filename, start, count)

### Parameters
- **market** (int) - Required - 市场代码：0 深圳，1 上海
- **stockcode** (string) - Required - 股票代码
- **filename** (string) - Required - 文件名，如 '000001.txt'
- **start** (int) - Required - 起始位置，参考公司信息目录接口的返回结果
- **count** (int) - Required - 数量，参考公司信息目录接口的返回结果

### Request Example
```python
api.get_company_info_content(0, '000001', '000001.txt', 0, 100)
```

### Response
#### Success Response
- 返回 list 结构，包含公司信息详情内容

#### Response Example
```python
[{'content': '...'}, ...]
```
```

--------------------------------

### 导入行情服务器列表 hq_hosts

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

从 pytdx.config.hosts 导入 hq_hosts 以获取常用服务器列表。

```python
from pytdx.config.hosts import hq_hosts
```

--------------------------------

### 融资融券账户直接还款

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

调用api.repay()进行直接还款，需要client_id和amount。

```python
api.repay(client_id, amount)
```

--------------------------------

### api.get_history_transaction_data(market, stockcode, start, count, date)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

查询历史分笔成交。参数：市场代码，股票代码，起始位置，数量，日期。

```APIDOC
## api.get_history_transaction_data(market, stockcode, start, count, date)

### Description
查询历史分笔成交。参数：市场代码，股票代码，起始位置，数量，日期。

### Method
get_history_transaction_data

### Endpoint
api.get_history_transaction_data(market, stockcode, start, count, date)

### Parameters
- **market** (int) - Required - 市场代码：0 深圳，1 上海
- **stockcode** (string) - Required - 股票代码
- **start** (int) - Required - 起始位置
- **count** (int) - Required - 数量
- **date** (int) - Required - 日期，格式如 20170209

### Request Example
```python
api.get_history_transaction_data(TDXParams.MARKET_SZ, '000001', 0, 10, 20170209)
```

### Response
#### Success Response
- 返回 list 结构，包含历史分笔成交数据

#### Response Example
```python
[{'time': '09:30', 'price': 10.0, 'volume': 100, ...}, ...]
```
```

--------------------------------

### 创建订单

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

调用api.send_order()创建订单，需要client_id、category、price_type、gddm、zqdm、price和quantity。

```python
api.send_order(client_id, category, price_type, gddm, zqdm, price, quantity)
```

--------------------------------

### api.get_security_bars(category, market, stockcode, start, count)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

获取K线数据。支持多种周期，如5分钟、15分钟、日K等。

```APIDOC
## api.get_security_bars(category, market, stockcode, start, count)

### Description
获取K线数据。支持多种周期，如5分钟、15分钟、日K等。

### Method
get_security_bars

### Endpoint
api.get_security_bars(category, market, stockcode, start, count)

### Parameters
- **category** (int) - Required - K线种类：0 5分钟K线, 1 15分钟K线, 2 30分钟K线, 3 1小时K线, 4 日K线, 5 周K线, 6 月K线, 7 1分钟, 8 1分钟K线, 9 日K线, 10 季K线, 11 年K线
- **market** (int) - Required - 市场代码：0 深圳，1 上海
- **stockcode** (string) - Required - 证券代码
- **start** (int) - Required - 指定的范围开始位置
- **count** (int) - Required - 用户要请求的K线数目，最大值为800

### Request Example
```python
api.get_security_bars(9, 0, '000001', 4, 3)
```

### Response
#### Success Response
- 返回 list 结构，包含K线数据

#### Response Example
```python
[{'open': 10.0, 'close': 10.5, ...}, ...]
```
```

--------------------------------

### 获取所有正在登录的client账号列表

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

调用api.get_active_clients()获取所有正在登录的client账号列表。

```python
api.get_active_clients()
```

--------------------------------

### 升级pytdx到最新版本

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/installation/

使用pip升级pytdx到最新版本。

```bash
> pip install -U pytdx
```

--------------------------------

### 使用 TdxHqPool_API 创建连接池并调用行情接口

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_pool/

该示例展示了如何使用 pytdx 的行情连接池 API。首先从 hq_hosts 中随机选取 5 个 IP 创建 AvailableIPPool，然后通过 sync_get_top_n(2) 选出主连接和热备连接，最后创建 TdxHqPool_API 对象并连接调用 get_xdxr_info 接口。注意 TdxHqPool_API 的第一个参数可以是 TdxHq_API 或 TdxExHq_API。

```python
from pytdx.hq import TdxHq_API
from pytdx.pool.ippool import AvailableIPPool
from pytdx.config.hosts import hq_hosts
import random
import logging
import pprint

ips = [(v[1], v[2]) for v in hq_hosts]
# 获取5个随机ip作为ip池
random.shuffle(ips)
ips5 = ips[:5]

## IP 池对象
ippool = AvailableIPPool(TdxHq_API, ips5)

## 选出M, H
primary_ip, hot_backup_ip = ippool.sync_get_top_n(2)

print("make pool api")
## 生成hqpool对象，第一个参数为TdxHq_API后者 TdxExHq_API里的一个，第二个参数为ip池对象。
api = TdxHqPool_API(TdxHq_API, ippool)

## connect 函数的参数为M, H 两组 (ip, port) 元组
with api.connect(primary_ip, hot_backup_ip):
    ## 这里的借口和对应TdxHq_API 或者 TdxExHq_API里的一样，我们通过反射调用正确的接口
    ret = api.get_xdxr_info(0, '000001')
    print("send api call done")
    pprint.pprint(ret)
```

--------------------------------

### 初始化 TdxHq_API 关闭异常抛出（默认）

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

设置 raise_exception=False（默认情况），调用 connect 失败时返回 false，调用普通接口出错时返回 None。

```python
# 默认情况
api = TdxHq_API(raise_exception=False)
```

--------------------------------

### 从GitHub安装pytdx最新版本

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/installation/

通过pip直接安装GitHub上的最新版本。

```bash
> pip install git+https://github.com/rainx/pytdx
```

--------------------------------

### 启用多线程支持

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

初始化时设置 multithread=True 以启用多线程版本，但建议使用多进程实现并发。

```python
api = TdxExHq_API(multithread=True)
```

--------------------------------

### 多线程支持

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

初始化 TdxExHq_API 时设置 multithread 参数为 True 以启用多线程支持。

```APIDOC
## 多线程支持

### Description
初始化 TdxExHq_API 时设置 multithread 参数为 True 以启用多线程支持。

### Method
TdxExHq_API(multithread=True)

### Endpoint
api = TdxExHq_API(multithread=True)

### Parameters
#### Path Parameters
- **multithread** (bool) - Optional - 是否启用多线程，默认 False

### Request Example
```python
api = TdxExHq_API(multithread=True)
```

### Response
#### Success Response
- 返回 TdxExHq_API 对象
```

--------------------------------

### 设置 TDX_DEBUG 环境变量启用调试模式

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

在命令行中设置环境变量 TDX_DEBUG=1 以启用调试模式，监控传输过程中的数据包传输情况。

```bash
> TDX_DEBUG=1 hqget -f 1
```

--------------------------------

### 查询K线数据

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

调用 get_instrument_bars 并传入K线周期、市场ID、证券代码、起始位置和数量，K线周期参考 TDXParams，市场ID可通过 get_markets 获得。

```python
api.get_instrument_bars(TDXParams.KLINE_TYPE_DAILY, 8, "10000843", 0, 100)
```

--------------------------------

### 引入交易接口

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

导入pytdx的交易API模块。

```python
from pytdx.trade import TdxTradeApi
```

--------------------------------

### 读取K线信息

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_k_data 读取K线信息，参数为股票代码、开始时间和结束时间。

```python
get_k_data('000001','2017-07-03','2017-07-10')
```

--------------------------------

### 获取股票列表

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_security_list 获取指定市场的股票列表，参数为市场代码和起始位置。

```python
api.get_security_list(1, 0)
```

--------------------------------

### 获取市场代码

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

调用 get_markets() 获取服务器支持的市场列表，返回结果可缓存。

```python
api.get_markets()
```

--------------------------------

### get_k_data(stockcode, start_date, end_date)

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

读取K线信息。参数：市场代码，开始时间，结束时间。注意：此方法未在类中定义，可能为独立函数。

```APIDOC
## get_k_data(stockcode, start_date, end_date)

### Description
读取K线信息。参数：市场代码，开始时间，结束时间。注意：此方法未在类中定义，可能为独立函数。

### Method
get_k_data

### Endpoint
get_k_data(stockcode, start_date, end_date)

### Parameters
- **stockcode** (string) - Required - 股票代码
- **start_date** (string) - Required - 开始时间，格式如 '2017-07-03'
- **end_date** (string) - Required - 结束时间，格式如 '2017-07-10'

### Request Example
```python
get_k_data('000001', '2017-07-03', '2017-07-10')
```

### Response
#### Success Response
- 返回 list 结构，包含K线数据

#### Response Example
```python
[{'date': '2017-07-03', 'open': 10.0, ...}, ...]
```
```

--------------------------------

### 查询分时行情

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

调用 get_minute_time_data 并传入市场ID和证券代码，市场ID可通过 get_markets 获得。

```python
api.get_minute_time_data(47, "IF1709")
```

--------------------------------

### 获取多只股票行情

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_security_quotes 传入市场代码和股票代码的元组列表，获取多只股票的行情信息。注意：非股票品种代码，有些获取的价格不是实际价格，如可转债为实际价格*10。

```python
api.get_security_quotes([(0, '000001'), (1, '600300')])
```

--------------------------------

### 使用pip安装pytdx

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/installation/

通过pip安装pytdx的标准命令。

```bash
> pip install pytdx
```

--------------------------------

### 启动TdxTradeServer服务

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

使用get_tts命令配置trade服务，建议配置多账号版本的TdxTradeServer。

```bash
> get_tts
```

--------------------------------

### 连接服务器

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

创建 TdxExHq_API 对象并连接到扩展行情服务器，支持普通连接和 with 语法自动断开。

```APIDOC
## 连接服务器

### Description
创建 TdxExHq_API 对象并连接到扩展行情服务器，支持普通连接和 with 语法自动断开。

### Method
connect

### Endpoint
api.connect(host, port)

### Parameters
#### Path Parameters
- **host** (string) - Required - 服务器地址
- **port** (int) - Required - 服务器端口

### Request Example
```python
from pytdx.exhq import TdxExHq_API
api = TdxExHq_API()
if api.connect('61.152.107.141', 7727):
    # ... same codes...
    api.disconnect()
```

### Response
#### Success Response
- **bool** - 连接成功返回 True，失败返回 False

### Notes
支持 with 语法，可省略 disconnect() 语句：
```python
with api.connect('61.152.107.141', 7727):
    # some codes
```
```

--------------------------------

### 读取财务信息

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_finance_info 读取财务信息，参数为市场代码和股票代码。

```python
api.get_finance_info(0, '000001')
```

--------------------------------

### 创建行情接口对象

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

实例化 TdxHq_API 对象，用于后续连接和调用行情方法。

```python
api = TdxHq_API()
```

--------------------------------

### 保存命令结果到文件 -o all.csv

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/hqget/

使用 -o/--output 参数将命令结果保存到文件，同时指定服务器和功能。根据 --df/--no-df 参数，保存为 CSV 或 Pickle 格式。

```text
hqget -o all.csv -s 119.147.212.81:7709 -f 4
```

--------------------------------

### 查询代码列表

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

调用 get_instrument_info 并传入起始位置和获取数量。

```python
api.get_instrument_info(0, 100)
```

--------------------------------

### 引入 pytdx 行情接口

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

导入 TdxHq_API 类，用于后续创建行情接口对象。

```python
from pytdx.hq import TdxHq_API
```

--------------------------------

### 获取历史财务数据列表

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_crawler/

使用 HistoryFinancialListCrawler 获取历史财务数据文件列表，返回包含 filename、filesize 和 hash 字段的 DataFrame。

```python
from pytdx.crawler.history_financial_crawler import HistoryFinancialListCrawler
crawler = HistoryFinancialListCrawler()
list_data = crawler.fetch_and_parse()
print(pd.DataFrame(data=list_data))
```

--------------------------------

### 获取指数K线示例

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_index_bars 获取指数K线数据，参数与 get_security_bars 类似。

```python
api.get_index_bars(9,1, '000001', 1, 2)
```

--------------------------------

### 板块相关参数

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

定义板块文件的常量，用于 get_and_parse_block_info 方法。

```python
# 板块相关参数
BLOCK_SZ = "block_zs.dat"
BLOCK_FG = "block_fg.dat"
BLOCK_GN = "block_gn.dat"
BLOCK_DEFAULT = "block.dat"
```

--------------------------------

### 使用TdxDailyBarReader读取通达信日K线文件

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_reader/

从通达信本地目录（如vipdoc/sz/lday/）读取日K线文件，返回pandas DataFrame，包含open、high、low、close、amount、volume列。示例中文件路径为/Users/rainx/tmp/vipdoc/sz/lday/sz000001.day。

```python
from pytdx.reader import TdxDailyBarReader, TdxFileNotFoundException
reader = TdxDailyBarReader()
df = reader.get_df("/Users/rainx/tmp/vipdoc/sz/lday/sz000001.day")

df 是pandas 的DateFrame格式， 输出为：

             open   high    low  close        amount     volume
date
1991-12-23  27.70  27.90  27.60  27.80  3.530600e+06     127000
1991-12-24  27.90  29.30  27.00  29.05  3.050250e+06     105000
1991-12-25  29.15  30.00  29.10  29.30  6.648170e+06     226900
1991-12-26  29.30  29.30  28.00  28.00  5.370400e+06     191800
1991-12-27  28.00  28.50  28.00  28.45  5.988725e+06     210500
...           ...    ...    ...    ...           ...        ...
2017-06-22   9.15   9.40   9.14   9.25  1.325211e+09  142695815
2017-06-23   9.23   9.27   9.16   9.25  5.383036e+08   58400441
2017-06-26   9.26   9.40   9.26   9.30  6.637629e+08   71076995

[6031 rows x 6 columns]

# 可以通过pandas将它保存为csv 等文件, 如:

df.to_csv("/tmp/000001.csv")
```

--------------------------------

### 读取除权除息信息

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_xdxr_info 读取除权除息信息，参数为市场代码和股票代码。

```python
api.get_xdxr_info(1, '600300')
```

--------------------------------

### logon

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

登录交易服务器，获取客户端ID。

```APIDOC
## logon

### Description
登录交易服务器，获取客户端ID。

### Method
N/A (SDK方法)

### Endpoint
N/A

### Parameters
- **ip** (string) - Required - 服务器IP地址
- **port** (number) - Required - 服务器端口
- **version** (string) - Required - 版本号
- **yyb_id** (string) - Required - 营业部ID
- **account_id** (string) - Required - 账户ID
- **trade_account** (string) - Required - 交易账户
- **jy_passwrod** (string) - Required - 交易密码
- **tx_password** (string) - Required - 通讯密码

### Request Example
```python
result = api.logon(ip, port, version, yyb_id, account_id, trade_account, jy_passwrod, tx_password)
```

### Response
#### Success Response
- **success** (boolean) - 是否成功
- **data** (object) - 返回数据，包含client_id
  - **client_id** (string) - 客户端ID

#### Error Response
- **success** (boolean) - false
- **error** (string) - 错误信息
```

--------------------------------

### 连接服务器并执行查询（标准格式）

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

使用 connect 方法连接服务器，执行查询代码后调用 disconnect 断开连接。

```python
if api.connect('61.152.107.141', 7727):
    # ... same codes...
    api.disconnect()
```

--------------------------------

### 查询分时行情

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_minute_time_data 查询分时行情，参数为市场代码和股票代码。

```python
api.get_minute_time_data(1, '600300')
```

--------------------------------

### 通过 HistoryFinancialReader 读取本地数据

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_crawler/

使用 HistoryFinancialReader 读取本地 .zip 或 .dat 文件，返回 DataFrame。

```python
from pytdx.reader import HistoryFinancialReader

# print(HistoryFinancialReader().get_df('/tmp/tmpfile.zip'))
print(HistoryFinancialReader().get_df('/tmp/gpcw20170930.dat'))
```

--------------------------------

### 初始化客户端

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

创建TdxTradeApi实例，用于与TdxTradeServer进行通信。

```APIDOC
## 初始化客户端

### Description
创建TdxTradeApi实例，用于与TdxTradeServer进行通信。

### Method
N/A (SDK初始化)

### Endpoint
N/A

### Parameters
- **endpoint** (string) - Required - TdxTradeServer的HTTP API地址
- **enc_key** (bytes) - Required - 加密密钥
- **enc_iv** (bytes) - Required - 加密初始化向量

### Request Example
```python
api = TdxTradeApi(endpoint="http://10.11.5.175:10092/api", enc_key=b"4f1cf3fec4c84c84", enc_iv=b"0c78abc083b011e7")
```

### Response
#### Success Response
- **api** (TdxTradeApi) - 初始化后的API实例
```

--------------------------------

### 使用 --no-df 参数后的原始数据输出

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/hqget/

在 --no-df 模式下，输入参数后输出为 OrderedDict 列表，包含完整的行情字段。

```text
参数：市场代码， 股票代码， 如： 0,000001 或 1,600300
请输入参数  [0,000001]:
--------------------
[OrderedDict([('market', 0),
              ('code', '000001'),
              ('active1', 2864),
              ('price', 9.19),
              ('last_close', 9.25),
              ('open', 9.23),
              ('high', 9.27),
              ('low', 9.16),
              ('reversed_bytes0', bytearray(b'\xbd\xc9\xec\x0c')),
              ('reversed_bytes1', -919),
              ('vol', 428899),
              ('cur_vol', 30),
              ('amount', 395218880.0),
              ('s_vol', 284703),
              ('b_vol', 144196),
              ('reversed_bytes2', 1),
              ('reversed_bytes3', 698),
              ('bid1', 9.18),
              ('ask1', 9.19),
              ('bid_vol1', 1078),
              ('ask_vol1', 5236),
              ('bid2', 9.17),
              ('ask2', 9.2),
              ('bid_vol2', 8591),
              ('ask_vol2', 3027),
              ('bid3', 9.16),
              ('ask3', 9.21),
              ('bid_vol3', 12638),
              ('ask_vol3', 3557),
              ('bid4', 9.15),
              ('ask4', 9.22),
              ('bid_vol4', 13234),
              ('ask_vol4', 2615),
              ('bid5', 9.14),
              ('ask5', 9.23),
              ('bid_vol5', 5377),
              ('ask_vol5', 6033),
              ('reversed_bytes4', 5768),
              ('reversed_bytes5', 1),
              ('reversed_bytes6', 16),
              ('reversed_bytes7', 83),
              ('reversed_bytes8', 20),
              ('reversed_bytes9', 0),
              ('active2', 2864)])]
```

--------------------------------

### 查询信息

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

调用api.query_data()查询信息，需要client_id和category。

```python
api.query_data(client_id, category)
```

--------------------------------

### 初始化 TdxHq_API 启用多线程支持

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

设置 multithread=True 以启用多线程模式，适用于需要并发访问的场景。

```python
api = TdxHq_API(multithread=True)
```

--------------------------------

### 初始化 TdxHq_API 启用异常抛出

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

设置 raise_exception=True，调用 connect 失败时抛出 TdxConnectionError 异常，调用普通接口出错时抛出 TdxFunctionCallError 异常。

```python
api = TdxHq_API(raise_exception=True)
```

--------------------------------

### 获取行情

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

调用api.get_quote()获取行情，需要client_id和code。

```python
api.get_quote(client_id, code)
```

--------------------------------

### 使用 --no-df 参数启动 hqget

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/hqget/

启动时添加 --no-df 参数，使输出使用原始数据格式而非 pandas DataFrame。

```text
> hqget --no-df
```

--------------------------------

### 读取公司信息详情

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_company_info_content 读取公司信息详情，参数为市场代码、股票代码、文件名、起始位置和数量。注意起始位置和数量参考上面接口的返回结果。

```python
api.get_company_info_content(0, '000001', '000001.txt', 0, 100)
```

--------------------------------

### 获取K线示例

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

调用 get_security_bars 获取指定股票的K线数据，参数包括 category、market、stockcode、start、count。

```python
api.get_security_bars(9,0, '000001', 4, 3)
```

--------------------------------

### get_active_clients

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_trade/

获取所有正在登录的client账号列表。

```APIDOC
## get_active_clients

### Description
获取所有正在登录的client账号列表。

### Method
N/A (SDK方法)

### Endpoint
N/A

### Parameters
无

### Request Example
```python
api.get_active_clients()
```

### Response
#### Success Response
- **success** (boolean) - 是否成功
- **data** (object) - 返回数据
```

--------------------------------

### 使用 with 语法连接服务器

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_hq/

使用 with 语法连接服务器，可自动断开连接，无需手动调用 disconnect()。

```python
with api.connect('119.147.212.81', 7709):
    # some codes
```

--------------------------------

### 查询分时行情

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

查询指定市场ID和证券代码的分时行情数据。市场ID可以通过 get_markets 获得。

```APIDOC
## 查询分时行情

### Description
查询指定市场ID和证券代码的分时行情数据。市场ID可以通过 get_markets 获得。

### Method
get_minute_time_data

### Endpoint
api.get_minute_time_data(market, code)

### Parameters
#### Path Parameters
- **market** (int) - Required - 市场ID，可通过 get_markets 获得
- **code** (string) - Required - 证券代码

### Request Example
```python
api.get_minute_time_data(47, "IF1709")
```

### Response
#### Success Response
- 返回分时行情数据
```

--------------------------------

### 创建 TdxExHq_API 对象

Source: https://pytdx-docs.readthedocs.io/zh-cn/latest/pytdx_exhq/

创建 API 对象实例，用于后续连接和查询。

```python
api = TdxExHq_API()
```
Tokens:
Raw