mirror of
https://ghfast.top/https://github.com/aeroxw/easy_tdx_max.git
synced 2026-09-12 19:14:19 +08:00
GitHub
574ffdd2a4
三个根因（全部实测核实）： 1. Category 22 直连接口为虚构协议——52 台已知服务器中 46 台可达的 全部仅回 2 字节空包，从未成功过；移除死代码与臆造解析格式。 2. 历史逐笔接口当日数据要收盘清算后才有，日 K 盘中已含当日 bar， 故 start=0 的最新一行恒为全 0——当日 bar 改走当日实时逐笔接口。 3. main_net_inflow 此前仅为 dataclass property，asdict 静默丢弃， 返回 DataFrame 无主力净额列——新增 _fund_flow_df_with_net 物化 （history 紧随 date 列、当日快照放首列）。 sync + async 双客户端同步修改；更新示例与三份文档；重写/新增回归 测试（当日实时逐笔路径、主力净额列断言）。
633 lines
16 KiB
Markdown
633 lines
16 KiB
Markdown
# easy_tdx API 参考文档
|
||
|
||
> 版本: 1.16.2 | 运行时依赖: pandas / tzdata / click | 需要网络连接通达信行情服务器
|
||
|
||
## 目录
|
||
|
||
- [快速开始](#快速开始)
|
||
- [客户端](#客户端)
|
||
- [TdxClient（同步）](#tdxclient同步)
|
||
- [AsyncTdxClient（异步）](#asynctdxclient异步)
|
||
- [连接与服务器选择](#连接与服务器选择)
|
||
- [市场信息](#市场信息)
|
||
- [K 线数据](#k-线数据)
|
||
- [分时数据](#分时数据)
|
||
- [逐笔成交](#逐笔成交)
|
||
- [财务与公司信息](#财务与公司信息)
|
||
- [板块信息](#板块信息)
|
||
- [资金流向](#资金流向)
|
||
- [文件下载](#文件下载)
|
||
- [市场统计](#市场统计)
|
||
- [数据模型](#数据模型)
|
||
- [枚举](#枚举)
|
||
- [异常](#异常)
|
||
- [涨跌停价计算](#涨跌停价计算)
|
||
|
||
---
|
||
|
||
## 快速开始
|
||
|
||
```python
|
||
from easy_tdx import TdxClient, Market, KlineCategory
|
||
|
||
# 自动选择最优服务器
|
||
with TdxClient.from_best_host() as c:
|
||
# 沪市证券总数
|
||
count = c.get_security_count(Market.SH)
|
||
|
||
# 浦发银行日K线
|
||
bars = c.get_security_bars(Market.SH, "600000", KlineCategory.DAY, 0, 10)
|
||
|
||
# 实时行情
|
||
quotes = c.get_security_quotes([(Market.SH, "600000"), (Market.SZ, "000001")])
|
||
```
|
||
|
||
---
|
||
|
||
## 客户端
|
||
|
||
### TdxClient（同步）
|
||
|
||
```python
|
||
TdxClient(host, port=7709, timeout=15.0, auto_reconnect=True)
|
||
```
|
||
|
||
| 参数 | 类型 | 默认值 | 说明 |
|
||
|------|------|--------|------|
|
||
| host | `str` | `KNOWN_HOSTS[0]` | 服务器 IP 地址 |
|
||
| port | `int` | `7709` | 服务器端口 |
|
||
| timeout | `float` | `15.0` | 连接/读写超时（秒） |
|
||
| auto_reconnect | `bool` | `True` | 断线自动重连 |
|
||
|
||
支持上下文管理器：`with TdxClient(...) as c:`
|
||
|
||
#### 工厂方法
|
||
|
||
```python
|
||
TdxClient.from_best_host(hosts=KNOWN_HOSTS, port=7709, timeout=15.0,
|
||
ping_timeout=5.0, auto_reconnect=True)
|
||
```
|
||
|
||
测量 `hosts` 中所有服务器延迟，选择最低延迟的建立连接。若全部不可达，回退到 `hosts[0]`。
|
||
|
||
### AsyncTdxClient（异步）
|
||
|
||
```python
|
||
AsyncTdxClient(host, port=7709, timeout=15.0, auto_reconnect=True, heartbeat_interval=60.0)
|
||
```
|
||
|
||
| 参数 | 类型 | 默认值 | 说明 |
|
||
|------|------|--------|------|
|
||
| heartbeat_interval | `float` | `60.0` | 心跳间隔（秒），≤0 禁用 |
|
||
|
||
所有方法均为 `async def`，使用 `await` 调用。支持异步上下文管理器：`async with AsyncTdxClient(...) as c:`
|
||
|
||
> **注意**：单个 AsyncTdxClient 仅维护一条 TCP 连接，并发调用在连接内串行执行。
|
||
|
||
---
|
||
|
||
## 连接与服务器选择
|
||
|
||
### ping_all
|
||
|
||
```python
|
||
TdxClient.ping_all(hosts=KNOWN_HOSTS, port=7709, timeout=5.0) -> list[tuple[str, float]]
|
||
```
|
||
|
||
测量多台服务器延迟，返回按延迟升序排列的 `(host, seconds)` 列表。
|
||
|
||
**示例**：
|
||
```python
|
||
results = TdxClient.ping_all()
|
||
for host, latency in results:
|
||
print(f"{host}: {latency * 1000:.1f} ms")
|
||
```
|
||
|
||
### connect / close
|
||
|
||
```python
|
||
c.connect() # 建立连接
|
||
c.close() # 关闭连接
|
||
```
|
||
|
||
建议使用上下文管理器自动管理。
|
||
|
||
---
|
||
|
||
## 市场信息
|
||
|
||
### get_security_count
|
||
|
||
```python
|
||
c.get_security_count(market: Market) -> int
|
||
```
|
||
|
||
获取指定市场的证券总数。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| market | `Market` | 市场代码（SZ/SH/BJ） |
|
||
|
||
### get_security_list
|
||
|
||
```python
|
||
c.get_security_list(market: Market, start: int) -> list[SecurityInfo]
|
||
```
|
||
|
||
获取证券列表（每页约 1000 条）。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| market | `Market` | 市场代码 |
|
||
| start | `int` | 分页偏移量（0, 1000, 2000, ...） |
|
||
|
||
### get_security_list_all
|
||
|
||
```python
|
||
c.get_security_list_all() -> list[SecurityInfo]
|
||
```
|
||
|
||
获取沪深 A 股完整列表，自动挂载行业信息（通达信行业 + 申万行业）。
|
||
|
||
**注意**：
|
||
- 内部会拉取 `tdxhy.cfg` 并遍历全部证券，耗时较长
|
||
- `Market.BJ` 因服务器端问题暂不纳入
|
||
|
||
**A股过滤规则**：
|
||
- 沪市：60xxxx（主板）、68xxxx（科创板）
|
||
- 深市：00xxxx（主板）、30xxxx（创业板）
|
||
|
||
### get_security_quotes
|
||
|
||
```python
|
||
c.get_security_quotes(stocks: list[tuple[Market, str]]) -> list[SecurityQuote]
|
||
```
|
||
|
||
批量获取实时五档行情，**最多 80 只/次**。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| stocks | `list[tuple[Market, str]]` | (市场, 代码) 列表 |
|
||
|
||
---
|
||
|
||
## K 线数据
|
||
|
||
### get_security_bars
|
||
|
||
```python
|
||
c.get_security_bars(market: Market, code: str, category: KlineCategory,
|
||
start: int, count: int = 800, *, bar_time: str = "start") -> pd.DataFrame
|
||
```
|
||
|
||
获取个股 K 线数据。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| market | `Market` | 市场代码 |
|
||
| code | `str` | 证券代码（如 "600000"） |
|
||
| category | `KlineCategory` | K 线周期 |
|
||
| start | `int` | 分页偏移（0 为最新） |
|
||
| count | `int` | 请求数量（最多 800） |
|
||
| bar_time | `str` | 时间戳语义，见下方说明 |
|
||
|
||
**bar_time（分钟级周期时间戳对齐）**：通达信协议默认用 bar **开始时间**打时间戳
|
||
（5min 线上午最后一根标 11:25、下午第一根标 13:00；午休 11:30–13:00 无 bar）。
|
||
传 `bar_time="end"` 切换为 bar **右端点**（= 开始 + 周期时长，标 11:30/13:05），
|
||
对齐 Tushare / 同花顺 / 聚宽约定。仅对分钟级周期（MIN_1/5/15/30/60）生效，
|
||
日线及以上不受影响。默认 `"start"` 保持完全向后兼容。
|
||
|
||
### get_index_bars
|
||
|
||
```python
|
||
c.get_index_bars(market: Market, code: str, category: KlineCategory,
|
||
start: int, count: int = 800, *, bar_time: str = "start") -> pd.DataFrame
|
||
```
|
||
|
||
获取指数 K 线数据。参数（含 `bar_time`）同 `get_security_bars`。
|
||
|
||
**常用指数**：
|
||
| 指数 | market | code |
|
||
|------|--------|------|
|
||
| 上证指数 | SH | 000001 |
|
||
| 深证成指 | SZ | 399001 |
|
||
| 创业板指 | SZ | 399006 |
|
||
| 沪深300 | SH | 000300 |
|
||
|
||
---
|
||
|
||
## 分时数据
|
||
|
||
### get_minute_time_data
|
||
|
||
```python
|
||
c.get_minute_time_data(market: Market, code: str) -> list[MinuteBar]
|
||
```
|
||
|
||
获取今日分时数据（240 条）。内部优先尝试历史接口，失败后回退到实时接口。
|
||
|
||
### get_history_minute_time_data
|
||
|
||
```python
|
||
c.get_history_minute_time_data(market: Market, code: str, date: int) -> list[MinuteBar]
|
||
```
|
||
|
||
获取历史某日分时数据。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| date | `int` | YYYYMMDD 格式（如 20250110） |
|
||
|
||
---
|
||
|
||
## 逐笔成交
|
||
|
||
### get_transaction_data
|
||
|
||
```python
|
||
c.get_transaction_data(market: Market, code: str,
|
||
start: int, count: int = 800) -> list[TransactionRecord]
|
||
```
|
||
|
||
获取当日逐笔成交。
|
||
|
||
### get_history_transaction_data
|
||
|
||
```python
|
||
c.get_history_transaction_data(market: Market, code: str, date: int,
|
||
start: int, count: int = 800) -> list[TransactionRecord]
|
||
```
|
||
|
||
获取历史逐笔成交。
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| date | `int` | YYYYMMDD 格式 |
|
||
| start | `int` | 分页偏移 |
|
||
| count | `int` | 请求数量（最多 800） |
|
||
|
||
---
|
||
|
||
## 财务与公司信息
|
||
|
||
### get_xdxr_info
|
||
|
||
```python
|
||
c.get_xdxr_info(market: Market, code: str) -> list[XdxrRecord]
|
||
```
|
||
|
||
获取除权除息历史记录。返回值按时间排序，包含分红、送股、配股、股本变动等。
|
||
|
||
### get_finance_info
|
||
|
||
```python
|
||
c.get_finance_info(market: Market, code: str) -> FinanceInfo
|
||
```
|
||
|
||
获取最新财务数据，包含股本结构、资产负债、利润指标等。
|
||
|
||
### get_company_info_category
|
||
|
||
```python
|
||
c.get_company_info_category(market: Market, code: str) -> list[CompanyInfoCategory]
|
||
```
|
||
|
||
获取公司信息文件目录，返回可用的文件名、起始偏移和长度。
|
||
|
||
### get_company_info_content
|
||
|
||
```python
|
||
c.get_company_info_content(market: Market, code: str, filename: str,
|
||
offset: int, length: int) -> str
|
||
```
|
||
|
||
读取公司信息文本内容。需先通过 `get_company_info_category` 获取文件名和长度。
|
||
|
||
---
|
||
|
||
## 板块信息
|
||
|
||
### get_block_info
|
||
|
||
```python
|
||
c.get_block_info(filename: str) -> list[TdxBlock]
|
||
```
|
||
|
||
获取并解析板块文件。
|
||
|
||
**常用文件名**：
|
||
| 文件名 | 说明 |
|
||
|--------|------|
|
||
| `block_zs.dat` | 行业/指数板块 |
|
||
| `block_gn.dat` | 概念板块 |
|
||
| `block_fg.dat` | 风格板块 |
|
||
|
||
---
|
||
|
||
## 资金流向
|
||
|
||
### get_fund_flow
|
||
|
||
```python
|
||
c.get_fund_flow(market: Market, code: str) -> pd.DataFrame
|
||
```
|
||
|
||
获取个股当日资金流向（基于 L1 逐笔数据统计）。返回含 `main_net_inflow`（主力净流入）列。
|
||
|
||
**资金分级**：
|
||
| 级别 | 单笔成交额 |
|
||
|------|-----------|
|
||
| 超大单 | > 100 万 |
|
||
| 大单 | 20 ~ 100 万 |
|
||
| 中单 | 4 ~ 20 万 |
|
||
| 小单 | ≤ 4 万 |
|
||
|
||
### get_history_fund_flow
|
||
|
||
```python
|
||
c.get_history_fund_flow(market: Market, code: str,
|
||
start: int, count: int) -> pd.DataFrame
|
||
```
|
||
|
||
获取历史日线资金流向序列，由"日K线取日期 + 逐笔成交重算"实现（标准服务器
|
||
无资金流专用指令，Issue #52）。当日 bar 盘中取当日实时逐笔。返回列含
|
||
`main_net_inflow`（主力净流入，单位元）。
|
||
|
||
---
|
||
|
||
## 文件下载
|
||
|
||
### get_report_file
|
||
|
||
```python
|
||
c.get_report_file(filename: str) -> bytes
|
||
```
|
||
|
||
从服务器拉取大文件（分块传输）。
|
||
|
||
**常用文件**：
|
||
| 文件名 | 说明 |
|
||
|--------|------|
|
||
| `base_info.zip` | 基础信息包 |
|
||
| `tdxhy.cfg` | 行业映射配置 |
|
||
|
||
---
|
||
|
||
## 市场统计
|
||
|
||
### get_market_stat
|
||
|
||
```python
|
||
c.get_market_stat() -> MarketStat
|
||
```
|
||
|
||
获取 A 股全市场涨跌统计（基于 880005 行情统计代码）。
|
||
|
||
**注意**：`suspended_count` 是 `total - up - down - neutral` 的残差估算值。
|
||
|
||
---
|
||
|
||
## 数据模型
|
||
|
||
### SecurityInfo
|
||
|
||
证券列表条目。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| market | `Market` | 市场代码 |
|
||
| code | `str` | 证券代码 |
|
||
| name | `str` | 证券名称 |
|
||
| volunit | `int` | 成交量单位（手 = volunit 股） |
|
||
| decimal_point | `int` | 价格小数位数 |
|
||
| pre_close | `float` | 昨收价 |
|
||
| industry_tdx | `str` | 通达信行业代码（扩展字段） |
|
||
| industry_sw | `str` | 申万行业代码（扩展字段） |
|
||
|
||
### SecurityQuote
|
||
|
||
实时五档行情。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| market | `Market` | 市场代码 |
|
||
| code | `str` | 证券代码 |
|
||
| price | `float` | 现价 |
|
||
| pre_close | `float` | 昨收 |
|
||
| open | `float` | 今开 |
|
||
| high | `float` | 最高 |
|
||
| low | `float` | 最低 |
|
||
| vol | `float` | 总成交量（手） |
|
||
| amount | `float` | 成交额（元） |
|
||
| bid1~bid5 | `float` | 买一到买五价 |
|
||
| bid_vol1~bid_vol5 | `float` | 买一到买五量 |
|
||
| ask1~ask5 | `float` | 卖一到卖五价 |
|
||
| ask_vol1~ask_vol5 | `float` | 卖一到卖五量 |
|
||
| s_vol | `float` | 内盘（主动卖） |
|
||
| b_vol | `float` | 外盘（主动买） |
|
||
| rise_speed | `float` | 涨速 |
|
||
| server_time | `str` | 服务器时间 |
|
||
|
||
### SecurityBar
|
||
|
||
K 线数据。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| open | `float` | 开盘价 |
|
||
| close | `float` | 收盘价 |
|
||
| high | `float` | 最高价 |
|
||
| low | `float` | 最低价 |
|
||
| vol | `float` | 成交量（股） |
|
||
| amount | `float` | 成交额（元） |
|
||
| year | `int` | 年 |
|
||
| month | `int` | 月 |
|
||
| day | `int` | 日 |
|
||
| hour | `int` | 时 |
|
||
| minute | `int` | 分 |
|
||
| datetime_str | `str` | 属性，格式化时间字符串 |
|
||
|
||
### MinuteBar
|
||
|
||
分时数据。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| price | `float` | 价格 |
|
||
| vol | `int` | 成交量 |
|
||
|
||
### TransactionRecord
|
||
|
||
逐笔成交。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| hour | `int` | 时 |
|
||
| minute | `int` | 分 |
|
||
| price | `float` | 成交价 |
|
||
| vol | `int` | 成交量 |
|
||
| buyorsell | `int` | 方向（0=买, 1=卖, 2=中性, 8=集合竞价） |
|
||
|
||
### XdxrRecord
|
||
|
||
除权除息记录。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| market | `Market` | 市场 |
|
||
| code | `str` | 代码 |
|
||
| year/month/day | `int` | 日期 |
|
||
| category | `int` | 事件类型（见 XDXR_CATEGORY_NAMES） |
|
||
| fenhong | `float \| None` | 每股分红（元） |
|
||
| peigujia | `float \| None` | 配股价 |
|
||
| songzhuangu | `float \| None` | 每股送转股比例 |
|
||
| peigu | `float \| None` | 每股配股比例 |
|
||
|
||
### FinanceInfo
|
||
|
||
最新财务数据。包含股本结构（流通股本、总股本、国家股等）、资产负债（总资产、净资产等）、利润指标（主营收入、净利润等）和每股指标。字段名使用拼音，完整列表见源码 `models/finance.py`。
|
||
|
||
### CompanyInfoCategory
|
||
|
||
公司信息文件目录。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| name | `str` | 目录名 |
|
||
| filename | `str` | 文件名 |
|
||
| start | `int` | 起始偏移 |
|
||
| length | `int` | 内容长度 |
|
||
|
||
### TdxBlock
|
||
|
||
板块信息。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| name | `str` | 板块名称 |
|
||
| category | `int` | 分类（0=行业, 1=地域, 2=概念, 3=风格） |
|
||
| count | `int` | 成分股数量 |
|
||
| codes | `list[str]` | 成分股代码列表 |
|
||
|
||
### MarketStat
|
||
|
||
市场统计。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| up_count | `int` | 上涨家数 |
|
||
| down_count | `int` | 下跌家数 |
|
||
| neutral_count | `int` | 平盘家数 |
|
||
| suspended_count | `int` | 停牌估算 |
|
||
| total_count | `int` | 总计 |
|
||
| total_amount | `float` | 总成交额 |
|
||
| total_volume | `float` | 总成交量 |
|
||
| total_market_cap | `float` | 总市值（元），来自 880001 收盘价 |
|
||
| limit_up_count | `int` | 涨停家数，来自 880006 close |
|
||
| limit_down_count | `int` | 跌停家数，来自 880006 open |
|
||
|
||
### FundFlow
|
||
|
||
资金流向。
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| super_in / super_out | `float` | 超大单流入/流出 |
|
||
| large_in / large_out | `float` | 大单流入/流出 |
|
||
| medium_in / medium_out | `float` | 中单流入/流出 |
|
||
| small_in / small_out | `float` | 小单流入/流出 |
|
||
| main_net_inflow | `float` | 属性：主力净流入（超大+大） |
|
||
| total_net_inflow | `float` | 属性：全单净流入 |
|
||
|
||
### HistoricalFundFlow
|
||
|
||
历史日线资金流向。字段同 FundFlow，额外包含 `year`/`month`/`day` 日期字段。
|
||
|
||
---
|
||
|
||
## 枚举
|
||
|
||
### Market
|
||
|
||
| 值 | 名称 | 说明 |
|
||
|----|------|------|
|
||
| 0 | SZ | 深圳 |
|
||
| 1 | SH | 上海 |
|
||
| 2 | BJ | 北京 |
|
||
|
||
### KlineCategory
|
||
|
||
| 值 | 名称 | 说明 |
|
||
|----|------|------|
|
||
| 0 | MIN_5 | 5 分钟 |
|
||
| 1 | MIN_15 | 15 分钟 |
|
||
| 2 | MIN_30 | 30 分钟 |
|
||
| 3 | MIN_60 | 60 分钟 |
|
||
| 4 | DAY | 日线 |
|
||
| 5 | WEEK | 周线 |
|
||
| 6 | MONTH | 月线 |
|
||
| 7 | MIN_1 | 1 分钟 |
|
||
| 8 | MIN_3 | 3 分钟（内部用） |
|
||
| 9 | YEAR | 年线 |
|
||
| 10 | SEASON | 季线 |
|
||
| 11 | YEAR_ALT | 年线（备用） |
|
||
|
||
---
|
||
|
||
## 异常
|
||
|
||
所有异常继承自 `TdxError`。
|
||
|
||
| 异常 | 说明 |
|
||
|------|------|
|
||
| `TdxError` | 基础异常 |
|
||
| `TdxConnectionError` | 连接错误（断线、超时等） |
|
||
| `TdxDecodeError` | 数据解析错误 |
|
||
| `TdxCommandError` | 命令执行错误 |
|
||
|
||
---
|
||
|
||
## 涨跌停价计算
|
||
|
||
### get_price_limits
|
||
|
||
```python
|
||
c.get_price_limits(market: Market, code: str, name: str,
|
||
pre_close: float) -> tuple[float | None, float | None]
|
||
```
|
||
|
||
按交易规则计算涨跌停价。返回 `(涨停价, 跌停价)`，不适用时对应位置为 `None`。
|
||
|
||
内部逻辑：
|
||
- 自动检测上市初期不设涨跌幅限制的窗口期
|
||
- 通过日 K 线条数估算已上市交易天数
|
||
- 调用 `compute_price_limits()` 执行规则计算
|
||
|
||
### compute_price_limits（独立函数）
|
||
|
||
```python
|
||
from easy_tdx.codec.price_rules import compute_price_limits
|
||
|
||
compute_price_limits(market, code, name, pre_close, listed_days=None)
|
||
-> tuple[float | None, float | None]
|
||
```
|
||
|
||
涨跌幅规则：
|
||
| 类型 | 涨跌幅 |
|
||
|------|--------|
|
||
| 主板（60/00） | ±10% |
|
||
| 科创板（68） | ±20% |
|
||
| 创业板（30） | ±20% |
|
||
| ST 股 | ±5% |
|
||
| 上市首 N 日 | 不设限制 |
|
||
|
||
---
|
||
|
||
## 全局常量
|
||
|
||
| 常量 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| `KNOWN_HOSTS` | `list[str]` | A 股行情服务器列表 |
|
||
| `KNOWN_EX_HOSTS` | `list[str]` | 扩展行情服务器列表 |
|
||
| `XDXR_CATEGORY_NAMES` | `dict[int, str]` | 除权除息事件类型映射 |
|