# TickDB Docs

## 文档

### 介绍

- [TickDB 文档](https://docs.tickdb.ai/zh-Hans/index.md): 统一实时行情数据 API，支持外汇、指数、美股、港股、A 股、期货和加密货币。

### 入门指南

- [快速开始](https://docs.tickdb.ai/zh-Hans/quick-start.md): 在几分钟内开始使用 TickDB。
- [套餐与定价](https://docs.tickdb.ai/zh-Hans/pricing.md): TickDB 提供多种套餐方案，满足从个人开发者到企业级的不同需求。
- [更新日志](https://docs.tickdb.ai/zh-Hans/release-notes.md): TickDB API 文档版本更新记录

### REST API

#### 通用行情接口

- [产品查询](https://docs.tickdb.ai/zh-Hans/rest/api_symbols.md): 查询 TickDB 支持的产品，覆盖外汇、指数、美股、港股、A股、中国期货、香港期货、加密货币等市场，产品列表持续增加中。
- [行情快照](https://docs.tickdb.ai/zh-Hans/rest/api_ticker.md): 获取一个或多个交易品种的实时市场行情数据。
- [K 线查询](https://docs.tickdb.ai/zh-Hans/rest/api_kline.md): 按周期和时间范围查询 K 线数据。
- [实时 K 线](https://docs.tickdb.ai/zh-Hans/rest/api_kline_latest.md): 获取当前时间周期内正在形成并实时更新的 K 线数据。
- [盘口深度](https://docs.tickdb.ai/zh-Hans/rest/api_depth.md): 获取交易品种的实时买卖盘口数据。
- [逐笔成交](https://docs.tickdb.ai/zh-Hans/rest/api_trades.md): 获取交易品种的逐笔成交记录。

#### 股票市场接口

##### 全量行情

- [A股全量行情](https://docs.tickdb.ai/zh-Hans/rest/api_ticker_cn_stock.md): 获取A股市场当前全量行情快照。
- [港股全量行情](https://docs.tickdb.ai/zh-Hans/rest/api_ticker_hk_stock.md): 获取港股市场当前全量行情快照。
- [美股全量行情](https://docs.tickdb.ai/zh-Hans/rest/api_ticker_us_stock.md): 获取美股市场当前全量行情快照。

##### 个股行情与指标

- [股票信息](https://docs.tickdb.ai/zh-Hans/rest/api_stock_info.md): 获取股票名称、交易所、币种、股本和每股指标等基础信息。
- [当日分时](https://docs.tickdb.ai/zh-Hans/rest/api_intraday.md): 获取股票当日的分时数据，包括每分钟的价格、成交量、成交额等信息。
- [复权因子](https://docs.tickdb.ai/zh-Hans/rest/api_ex_factors.md): 获取 A 股、港股和美股的前复权、后复权因子。
- [综合指标](https://docs.tickdb.ai/zh-Hans/rest/api_calc_index.md): 获取股票的价格涨跌、成交、资金流向及估值等综合指标。
- [资金流向](https://docs.tickdb.ai/zh-Hans/rest/api_capital_flow.md): 获取股票的资金流向数据，包括主力资金、大单、中单、小单的流入流出情况。

##### 公司概况

- [公司资料](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_profile.md): 获取公司的基本资料、所属市场、行业和上市信息。
- [高管与董事](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_executives.md): 获取公司当前高管、董事及关键人员列表。
- [营收构成](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_segments_latest.md): 展示最近一期按业务或地区划分的收入金额和占比。
- [历史营收构成](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_segments_history.md): 展示历史报告期按业务或地区划分的收入金额和占比。

##### 财务报表

- [财务字段字典](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/financial_fields_dictionary.md): 财务报表接口返回字段代码、指标名称及数值口径说明。
- [近期财务报表](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_financials_latest.md): 查询最近若干期利润表、资产负债表或现金流量表的指标数据。
- [年度财务报表](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_financials_annual.md): 查询最近若干年的利润表、资产负债表或现金流量表指标数据。
- [财务数据 TTM](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_financials_ttm.md): 查询最近四个有效单季汇总的近12个月利润表或现金流量表指标。

##### 估值与行业

- [最新估值](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_valuation_latest.md): 获取股票当前市盈率及近一年区间统计。
- [历史估值](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_valuation_ts.md): 查询市盈率（PE）按日或按月的历史数值。
- [同行估值对比](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_industry_peers.md): 查询与该股票同行的公司及其估值、每股收益等可比指标。
- [行业估值分布](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_industry_dist.md): 获取股票所属行业的估值分布和样本统计。
- [行业指标排行](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_industries_rank.md): 查询指定市场按行业指标排序的结果。
- [行业分类层级](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_industries_tree.md): 查询指定行业所属的顶层分类及下级行业分类。

##### 分红与公司行动

- [分红记录](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_dividends.md): 查询股票的分红记录，包括历史及已知的未来分红事件，支持日期、类型和分页筛选。
- [股息TTM](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_dividends_ttm.md): TTM 指截至统计日的最近 12 个月；查询这段时间内按币种汇总的每股现金股息。
- [股票回购](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_buyback.md): 获取公司回购计划、执行情况和历史指标。
- [公司行动](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_corp_actions.md): 查询拆股、并股、配股、代码变更等公司行动事件。

##### 股东与机构持仓

- [最新股东结构](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_shareholders_latest.md): 获取当前股东结构快照。
- [股东持仓](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_shareholders_top.md): 查询主要股东在不同报告期的持股情况、持仓变动及详情可用状态。
- [股东持仓详情](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_shareholder_detail.md): 根据股东对象 ID 查询单个股东的持仓和交易明细。
- [持股基金](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_fund_holdings_latest.md): 查询哪些基金披露持有指定股票，以及该股票在各基金持仓中的比例；支持分页查询。

##### 财经日历

- [财报日历](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_calendar_report.md): 查询财报和业绩公布事件。
- [股息日历](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_calendar_dividend.md): 查询分红派息事件。
- [拆股日历](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_calendar_split.md): 查询拆股、合股等事件。
- [新股日历](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_calendar_ipo.md): 查询新股发行与上市事件。
- [其他日历](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_calendar_other.md): 按类别查询宏观数据、休市、会议等其他财经事件。

##### 市场资讯

- [市场状态](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_market_status.md): 查询不同市场当前的交易阶段和市场时间。
- [交易时段](https://docs.tickdb.ai/zh-Hans/rest/api_trading_sessions.md): 查询一个或全部支持市场的交易时段信息，包括开盘时间、收盘时间等。
- [交易日历](https://docs.tickdb.ai/zh-Hans/rest/api_trade_days.md): 查询指定市场在特定时间范围内的交易日列表，用于判断某日是否为交易日。
- [个股新闻](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_news.md): 获取个股新闻列表、发布时间和正文可用状态。
- [新闻详情](https://docs.tickdb.ai/zh-Hans/rest/fundamentals/api_news_detail.md): 根据新闻 ID 查询新闻正文或可用摘要。

#### 其他接口

- [APIKey管理](https://docs.tickdb.ai/zh-Hans/rest/api_key_status.md): 无需登录官网，即可查询 API Key 的到期情况，便于定时检查和设置提醒。

### WebSocket 文档

- [最佳实践](https://docs.tickdb.ai/zh-Hans/websocket/websocket_quickstart.md): WebSocket 连接、压缩、心跳与断线重连。
- [实时行情（Ticker）](https://docs.tickdb.ai/zh-Hans/websocket/ticker.md)
- [盘口深度（Depth）](https://docs.tickdb.ai/zh-Hans/websocket/depth.md)
- [逐笔成交（Trade）](https://docs.tickdb.ai/zh-Hans/websocket/trade.md)
- [心跳检测（Ping）](https://docs.tickdb.ai/zh-Hans/websocket/ping.md)
- [A 股全量行情](https://docs.tickdb.ai/zh-Hans/websocket/ticker_cn_stock.md): A 股全量行情订阅；建立 WebSocket 连接时须协商 permessage-deflate 压缩。
- [港股全量行情](https://docs.tickdb.ai/zh-Hans/websocket/ticker_hk_stock.md): 港股全量行情订阅；建立 WebSocket 连接时须协商 permessage-deflate 压缩。
- [美股全量行情](https://docs.tickdb.ai/zh-Hans/websocket/ticker_us_stock.md): 美股全量行情订阅；建立 WebSocket 连接时须协商 permessage-deflate 压缩。

### 参考

- [数据规范](https://docs.tickdb.ai/zh-Hans/data-specification.md): 交易品种命名、时间戳和 K 线间隔规则。
- [错误码说明](https://docs.tickdb.ai/zh-Hans/errors.md): 接口返回的错误码含义及处理建议。

## OpenAPI Specs

- [openapi](/openapi.yaml)
- [openapi.base](/openapi.base.yaml)

## AsyncAPI Specs

- [asyncapi](/asyncapi.json)
- [asyncapi.base](/asyncapi.base.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Traditional Chinese (61 pages)](https://docs.tickdb.ai/_llms/zh-hant.txt): Documentation for Traditional Chinese.
- [English (61 pages)](https://docs.tickdb.ai/_llms/en.txt): Documentation for English.


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