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

# TickDB 文档

> 统一实时行情数据 API，支持外汇、指数、美股、港股、A 股、期货和加密货币。

欢迎使用 **TickDB 在线文档**。

TickDB 是一个**面向开发者的统一实时行情数据 API**，通过单一连接即可访问多个金融市场的实时与历史行情数据，帮助你专注于业务和策略本身。

***

## 什么是 TickDB？

TickDB 专为需要**可靠、低延迟、可长期依赖**行情数据的开发者而构建。

通过 **一次接入（one connection）**，即可无缝访问外汇、贵金属、指数、美股、港股、A 股、期货和加密货币等多个市场的行情数据。

TickDB 支持多种数据形式，包括 **tick 级成交数据、盘口深度（Order Book）、K 线（Candlestick）和全量市场行情**，并提供 **财务与基本面数据、财经日历和市场资讯**。可通过 **REST API 与 WebSocket** 接入，适用于量化交易、实时行情系统、基本面研究、交易平台与数据分析等场景。

***

## 核心特性

* **统一接入**\
  一套 API 覆盖多个市场和资产类别

* **实时数据**\
  基于 WebSocket 的流式推送，适用于实时行情场景

* **全量行情**
  覆盖A股、港股和美股；单次 REST 请求即可获取指定市场的完整行情快照，一次 WebSocket 订阅即可持续接收该市场全部标的的实时行情更新

* **多市场支持**\
  外汇、贵金属、指数、美股、港股、A 股、期货、加密货币

* **财务与基本面**
  提供公司资料、财务报表、估值、行业、分红和股东持仓等数据

* **财经日历**
  按财报、股息、拆股、新股和其他事件分类查询

* **市场资讯**
  提供市场状态、交易时段、交易日历和个股新闻

* **开发者友好**\
  REST API + WebSocket，接口清晰、文档完整、示例齐全

* **AI 友好**\
  提供实时行情、财务与基本面、财经日历和市场资讯等结构化数据输入，便于 AI 开展公司分析、市场监控、事件跟踪与研究辅助；支持 Skill、MCP、CLI 多种接入方式

***

## AI 集成

TickDB 提供三档 AI 原生接入方式，从零配置对话到终端自动化全覆盖。

### Skill

**对话即用，零配置**

通过 [ClawHub](https://clawhub.com) 一键安装，任意 LLM 即可调用 TickDB 行情数据。

```bash theme={null}
npx clawhub@latest install tickdb-market-data
```

* 零注册自动试用
* 72 核心品种免费
* 任意 LLM 通用

### MCP

**永久集成，一次配置**

通过 Hosted MCP Server 接入，兼容 Claude Code、Cursor、Kiro、Zed 等所有 MCP 客户端。

配置示例（以 Claude 为例，路径：`~/.claude/settings.json`）：

```json theme={null}
{
  "mcpServers": {
    "tickdb": {
      "type": "http",
      "url": "https://mcp.tickdb.ai/",
      "headers": {
        "X-TickDB-Key": "<YOUR_API_KEY>"
      }
    }
  }
}
```

* Hosted mcp.tickdb.ai，无需自部署
* HTTPS + Header 鉴权
* 兼容所有 MCP 协议客户端
* 提供 13 个工具，与 REST API 端点一一对应

### CLI

**终端 & AI Agent 就绪**

全局安装后即可在终端直接查询行情，也适合 Agent 通过 bash-tool 调用。

```bash theme={null}
npm install -g tickdb
tickdb config set-key YOUR_API_KEY
tickdb ticker BTCUSDT,XAUUSD,AAPL.US
```

* JSON / 表格双输出
* 16 个原生命令
* Bash-tool 友好，适合 Agent 调用

### llms.txt

**为 AI 提供文档上下文**

如需让 AI 助手了解 TickDB 文档，可向其提供以下地址：

```text theme={null}
https://docs.tickdb.ai/llms.txt
```

如需包含全部页面正文的完整版本，请使用：

```text theme={null}
https://docs.tickdb.ai/llms-full.txt
```

详细信息请访问 [TickDB AI 接入](https://tickdb.ai/ai-tools)。

***

## 典型使用场景

* **量化交易**\
  作为策略与算法系统的实时行情数据源

* **行情看板**\
  实时价格展示、资产与投资组合监控

* **交易应用**\
  构建类似 TradingView 的行情界面与图表系统

* **数据分析与回测**\
  历史行情分析、策略研究与回测

* **基本面研究**
  结合财务报表、估值、行业和股东持仓进行公司分析

* **市场监控**
  利用全量行情、新闻和财经日历跟踪市场变化与重要事件

* **金融服务集成**\
  集成到现有交易平台或金融基础设施中

***

## 入门指南

* **快速开始** - 几分钟内开始使用
* **更新日志** - 版本更新记录

## REST API

### 通用行情接口

* **可用交易品种** - 查询支持的交易品种
* **行情快照** - 实时行情快照
* **K 线查询** - 按周期和时间范围查询 K 线数据
* **实时 K 线** - 当前周期正在形成的 K 线数据
* **盘口深度** - 实时买卖盘口数据
* **逐笔成交** - 逐笔成交记录

### 股票市场接口

#### 全量行情

A股、港股和美股全市场行情快照

#### 个股行情与指标

股票信息、当日分时、综合指标和资金流向

#### 公司概况

公司资料、高管董事和营收构成

#### 财务报表

近期、年度和 TTM 财务数据及字段字典

#### 估值与行业

最新估值、历史估值、同行对比和行业数据

#### 分红与公司行动

分红、股息 TTM、股票回购和公司行动

#### 股东与机构持仓

股东结构、股东持仓和持股基金

#### 财经日历

财报日历、股息日历、拆股日历、新股日历和其他日历

#### 市场资讯

市场状态、交易时段、交易日历和个股新闻

## WebSocket 文档

### 最佳实践

WebSocket 连接、压缩、心跳与断线重连

### Playground

直接在七个频道页面查看订阅方式与消息格式，包括 A 股、港股、美股全量行情及 ticker、depth、trade、ping。

## 参考

* **数据规范** - 交易品种命名与格式
* **错误码说明** - 错误码与处理方式

***

**文档版本**: v1.0.3


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.