Skip to main content

安装

使用 pip 安装 TickFlow Python SDK:
SDK 支持 Python 3.9+,推荐使用 Python 3.10 或更高版本。

免费服务(快速体验)

如果你只需要日K线数据和标的信息(不需要实时行情),可以直接使用免费服务,无需注册:
免费服务特点:
  • ✅ 无需注册,直接使用
  • ✅ 提供历史日K线数据(1d、1w、1M、1Q、1Y)
  • ✅ 提供标的信息、交易所、标的池查询
  • ❌ 不提供实时行情
  • ❌ 不提供分钟级K线(1m、5m、15m、30m、60m)
  • ⚠️ 日K数据为历史数据,盘中不会实时更新
免费服务适合:
  • 历史数据回测
  • 研究学习
  • 日级别策略开发(收盘后)
如需实时行情、分钟K线或更高频率访问,请继续阅读下方的完整服务配置。

完整服务(需注册)

1

获取 API Key

访问 tickflow.org 登录后,在控制台一键生成你的 API Key。
2

配置认证

有两种方式配置 API Key:
3

发起第一个请求

如果看到股票价格输出,说明 SDK 已配置成功!

标的代码格式与支持市场

所有按标的查询的接口(行情、K 线等)均使用统一标的代码,格式为:代码.市场后缀(中间为英文点号)。

标的代码格式

  • 格式:代码.市场后缀
  • 示例:
    • 股票:600000.SH(浦发银行)、000001.SZ(平安银行)、920662.BJ(方盛股份)
    • ETF:510300.SH(沪深 300 ETF)、159915.SZ(创业板 ETF)
    • 指数:000001.SH(上证指数)、399006.SZ(创业板指数)
代码部分使用交易所官方代码(如 6 位 A 股代码、合约代码等),市场后缀见下表。

支持的市场(后缀)

目前支持状态

  • A 股(SH / SZ / BJ):已支持。可查实时行情、日 K、分钟 K、日内分时、财务数据、标的池(如 CN_Equity_A)等。
  • 美股(US):已支持。实时行情、全量历史日 K 线(支持前复权/后复权)、除权因子、标的池(US_Equity)。
  • 港股(HK):已支持。实时行情、全量历史日 K 线(支持前复权/后复权)、除权因子、标的池(HK_Equity)。
按标的查询时传入上述格式的字符串或列表即可,例如:
输出示例

基础用法

标的信息

输出示例

标的池

输出示例

K 线获取

单次单标的最多获取 10000 根 K 线

非批量

单只标的日 K、周 K 等,使用 tf.klines.get(symbol, ...)
输出示例

批量(推荐)

多只标的一次性拉取,使用 tf.klines.batch(symbols, ...),适合大量标的:
输出示例

复权方式

通过 adjust 参数指定复权类型:
东方财富、同花顺等软件默认使用差值前复权。如需价格一致,请使用 adjust="forward_additive"

时间区间

通过 start_timeend_time 指定时间范围(毫秒时间戳),返回数据条数受到 count 的限制:
也可以同时使用 countend_time,获取某个时间点之前的 N 根 K 线:

除权因子

查看标的的历史除权因子:

日内分时

当日分钟 K 线(1 分钟、5 分钟等),按单只或批量调用。

非批量

单只标的当日分钟线,使用 tf.klines.intraday(symbol, ...)
输出示例

批量

多只标的当日分钟线,使用 tf.klines.intraday_batch(symbols, ...)
输出示例

获取实时行情

按标的代码查询

输出示例

按标的池查询

输出示例

市场深度(五档行情)

市场深度为 Pro / Expert 套餐功能,也可单独订阅。

单只标的

查询单只标的的五档买卖盘口:
输出示例

批量

多只标的的五档行情,使用 tf.depth.batch(symbols)
输出示例
批量查询需要 Pro(最多 100 个标的)或 Expert(最多 200 个标的)套餐。超过单次上限时,SDK 会自动分批并发请求并合并结果。

财务数据

财务数据为 Expert 套餐功能,也可单独订阅。

利润表

输出示例

资产负债表

输出示例

现金流量表

输出示例

核心财务指标

输出示例

股本表

输出示例

更多过滤条件

  • 仅获取最新一期数据
输出示例
  • 按时间范围过滤
输出示例

WebSocket 实时推送

WebSocket 为付费功能,需要订阅包含 WebSocket 实时行情的套餐(如 Expert)或单独开启。市场深度频道额外需要「市场深度」权限。
通过 WebSocket 订阅标的后,服务端会持续推送行情变动,适合低延迟、持续接收行情更新的场景。 SDK 提供 tf.stream(统一推送),按频道订阅行情和盘口:

基本用法

输出示例
depth 频道需要「市场深度」权限(Pro / Expert 或单独订阅)。无权限时订阅会收到错误提示,不影响其他频道。

非阻塞模式

在后台线程运行 WebSocket,主线程继续执行其他逻辑:

异步用法

如果只需获取某一时刻的行情快照,使用 REST 接口 tf.quotes.get() 更为简单。完整的 WebSocket 协议说明和多语言示例请参考 WebSocket 文档

异步使用

对于高并发场景,使用异步客户端:

下一步

完整示例

查看更多使用场景和代码示例

最佳实践

了解生产环境的最佳实践