Skip to content

Releases: TickDB/tickdb-api-docs

TickDB API Documentation v1.0.1

13 Mar 06:48
2f991c4

Choose a tag to compare

TickDB API 文档 v1.0.1 发布说明

📘 本发布说明以 简体中文 为主。
📄 其他语言版本详见附件:

  • 繁體中文:附件 RELEASE_NOTES_v1.0.1_zh_TW.md
  • English: attached RELEASE_NOTES_v1.0.1_en.md

TickDB API 文档 v1.0.1 发布
本次版本主要针对 TickDB API 文档进行全面优化,提升开发者使用体验,并新增股票市场专属接口,同时完善 WebSocket 功能说明。


新增功能

新增股票市场专属接口

  • 当日分时数据接口
  • 股票详细信息接口
  • 交易时段查询接口
  • 交易日历查询接口
  • 市场指标数据接口
  • 资金流向数据接口

重要改进

WebSocket 文档重构

  • 新增 ping/pong 心跳机制说明
  • 更新 ticker 频道消息格式(按市场类型区分字段)
  • 修正 trade 频道响应格式(包含 trades 数组)
  • depth 频道新增 A 股支持

文档内容优化

  • 完善所有接口的请求参数和返回字段说明
  • 更新支持市场标注和示例
  • 统一术语翻译
  • 优化入门指南和数据规范

🌐 在线文档

https://docs.tickdb.ai


🔖 版本信息

  • 文档版本:v1.0.1
  • 发布日期:2026-03-13
  • 上一版本:v1.0.0(2026-01-21)

TickDB API Documentation v1.0.0

21 Jan 15:52
4ad86bb

Choose a tag to compare

TickDB API 文档 v1.0.0 发布说明

📘 本发布说明以 简体中文 为主。
📄 其他语言版本详见附件:

  • 繁體中文:附件 RELEASE_NOTES_zh_TW.md
  • English: attached RELEASE_NOTES_en.md

TickDB API 文档 v1.0.0 正式发布
这是 TickDB 对外发布的第一个稳定版 API 文档,标志着文档进入 1.x 稳定系列


✨ 主要内容

🌍 统一多市场行情数据

单一 API 即可访问以下市场:

  • 外汇
  • 贵金属
  • 指数
  • 美股
  • 港股
  • A 股
  • 加密货币

🔌 REST API(完整)

  • 可用交易品种与市场列表
  • K 线周期定义
  • 历史 K 线查询
  • 最新(进行中)K 线
  • 行情快照(Ticker)
  • 订单簿深度(Depth)
  • 最新成交(Trades)

⚡ WebSocket API

  • 连接与认证流程
  • 订阅 / 取消订阅
  • 支持频道(ticker / depth / trade)
  • 消息结构与字段说明
  • 各市场使用限制与最佳实践

❗ 错误处理

  • 统一的错误返回格式
  • HTTP 与 WebSocket 错误码
  • 常见错误说明与解决建议

🧑‍💻 开发者体验

  • 清晰的 Symbol 命名规范
  • 多市场使用示例
  • REST / WebSocket 代码示例
  • 基于 Mintlify 构建的在线文档

🌐 在线文档

https://docs.tickdb.ai


🔖 版本策略

  • 本版本为 v1.x 稳定文档系列起点
  • 后续版本规划:
    • 1.0.1, 1.0.2:文档修订与补充说明
    • 1.1.0:新增 API 或功能说明

文档版本:v1.0.0
发布日期:2026-01-21