From 725db30e474685eb3027ec58c334a68414d980a4 Mon Sep 17 00:00:00 2001 From: shy3130 Date: Sun, 23 Aug 2026 13:48:24 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=95=B0=E6=8D=AE=E6=BA=90=E5=8F=A3?= =?UTF-8?q?=E5=BE=84=E5=AF=B9=E9=BD=90=E6=8F=92=E4=BB=B6=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - configuration.md: "本项目基于 TickFlow 数据源" 改为内置默认 + 插件化接入第三方, 链接两篇接入文档 - features.md: 「TickFlow 多源数据」节改为「数据源插件化」, 补 YAML 自定义源/插件源(stock-sdk)与五数据集自由组合说明 - custom-data-source.md: 支持范围三类 → 五类, 补 minute/financial 数据集契约 (与后端 DatasetName 和 provider 实现一致); 仅 depth5 暂无数据集契约仍由 TickFlow 提供 --- docs/configuration.md | 2 +- docs/custom-data-source.md | 6 ++++-- docs/features.md | 6 ++++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 15e8ef1..34236e8 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -12,7 +12,7 @@ TICKFLOW_API_KEY= # 留空 = None 模式(历史日K免费);填 Key = 按订阅档位解锁 ``` -本项目基于 [TickFlow](https://tickflow.org) 数据源。 +TickFlow 是内置默认数据源;同时支持插件化接入第三方数据源(YAML 声明自有接口见 [custom-data-source.md](./custom-data-source.md),插件开发见 [plugin-development.md](./plugin-development.md)),在面板 **设置 → 数据源** 切换。 - **留空(None 模式)**:通过 free-api 使用历史日 K(当日数据盘后 1-2 小时可用),**无需付费**即可体验核心选股/回测功能 - **填入 API Key**:按你的订阅档位解锁更多能力 diff --git a/docs/custom-data-source.md b/docs/custom-data-source.md index ca0ebb2..0d949f5 100644 --- a/docs/custom-data-source.md +++ b/docs/custom-data-source.md @@ -4,15 +4,17 @@ ## 支持范围 -当前自定义源支持三类数据: +当前自定义源支持五类数据: | 数据集 | 配置名 | 说明 | | --- | --- | --- | | 日K | `daily` | 批量返回一组股票在指定区间内的日K | | 除权因子 | `adj_factor` | 批量返回一组股票的复权因子 | | 实时行情 | `realtime` | 返回全市场快照,用于盘中 enriched 增量计算 | +| 分钟K | `minute` | 返回 1m 分钟K(需映射出 symbol / datetime / OHLC / 量额) | +| 财务数据 | `financial` | 一个配置覆盖全部财务表,请求时把表名作为参数传给上游;字段由数据源决定,仅需映射出 symbol | -分钟K、财务、深度盘口暂时仍走 TickFlow。 +深度盘口(depth5)暂无数据集契约,仍由 TickFlow 提供。 ## 配置位置 diff --git a/docs/features.md b/docs/features.md index 8e9c09d..1afbfbe 100644 --- a/docs/features.md +++ b/docs/features.md @@ -108,9 +108,11 @@ ## 🧰 数据与扩展 -### TickFlow 多源数据 +### 数据源插件化 -日 K / 分钟 K / 指数 / 财务 / 实时行情,基于 [TickFlow](https://tickflow.org) 官方 SDK。 +内置 [TickFlow](https://tickflow.org) 官方 SDK(日 K / 分钟 K / 指数 / 财务 / 实时行情),同时支持接入第三方数据源:YAML 声明自有 HTTP 接口,或开发插件源(参考实现 stock-sdk,Docker 镜像已内置)。五个数据集(daily / adj_factor / realtime / minute / financial)按源声明自由组合,在「设置 → 数据源」切换。 + +详见 [custom-data-source.md](./custom-data-source.md) 与 [plugin-development.md](./plugin-development.md)。 ### 🔌 第三方数据接入(重点)