使用知识库

暗流订阅用户
API 使用知识库

这里整理的是暗流 Pro API 的正式使用说明，适合接入你自己的网站、数据面板、提醒工具或自动化流程。页面覆盖快速开始、接口能力、参数说明、错误排查和使用建议，重点帮助你从“拿到 API Key”顺畅走到“稳定使用”。

正式域名可用安全访问已开启 X-API-Key 鉴权适合产品接入

查看快速开始查看准备项

统一入口 https://dash.hfd.fund 当前公开入口使用 `/api/gateway/` 前缀，按分组访问 `indicators` 和 `raw` 接口。

访问方式 Header 鉴权 每次请求都需要带上 `X-API-Key`，系统会根据它识别你的调用权限。

可用能力 指标 + 原始信号 当前提供指标数据和原始信号两大类接口，适合展示、分析、提醒和数据整理。

统一入口 1

统一入口为 `https://dash.hfd.fund`，便于直接接入和后续维护。

接口分组 2

接口分为指标 API 与原始数据 API，两类能力清晰分开。

核心指标 12

当前可用 12 个核心指标，支持 `30m / 1h / 4h` 三个周期。

访问凭证 API Key

统一使用 `X-API-Key`，使用方式简单，适合稳定调用。

快速上手

快速开始

第一次使用时，只需要确认接口地址、访问凭证和一个示例接口，就可以很快完成首次测试。

接入基础信息

接口地址：`https://dash.hfd.fund`
公开前缀：`/api/gateway/`
访问方式：安全连接
返回格式：`application/json`

访问凭证

字段名称：`X-API-Key`
字段值：你的 API Key
建议妥善保管，不要直接公开展示

标准时间周期

30m 1h 4h

交易对格式

统一大写，例如：`BTCUSDT`
不建议使用小写或省略 `USDT` 后缀

首个健康检查请求

curl -H "X-API-Key: your_api_key" "https://dash.hfd.fund/api/gateway/indicators/health"

访问说明

访问方式

所有接口都需要通过请求头传入 `X-API-Key`。如果字段缺失、填写错误或没有权限，请求会直接失败。

当前规则

缺少 `X-API-Key`：返回鉴权失败。
Key 错误：返回鉴权失败。
所有业务接口都使用同一套访问校验方式。
当前健康接口也受鉴权保护，避免被公网裸探测。
当前按 API Key 控制最小调用间隔，默认间隔为 `100` 秒。

使用建议

不要把 API Key 明文写在公开页面中。
建议把 API Key 保存在安全的位置。
如果有多人使用，建议区分不同的使用凭证。
如果你的产品有大量调用，建议先做好本地缓存和调用频率控制。

字段示例

X-API-Key: your_api_key

Indicators API

指标 API

指标 API 提供暗流 Pro 的核心指标数据，适合图表展示、信号看板、提醒场景和研究分析。

GET /api/gateway/indicators/health 健康检查

返回服务、数据库、鉴权启用状态等基础健康信息，适合作为接入首测与监控探针。

GET /api/gateway/indicators/meta 元信息

返回当前可用的指标、周期和交易对，适合初始化页面、下拉菜单和能力检查。

GET /api/gateway/indicators/data 指标主接口

返回某个币种、某个周期、某个指标的最新数据快照，是最核心的业务接口。

必填参数

`symbol`：例如 `BTCUSDT`
`timeframe`：`30m / 1h / 4h`
`indicator`：指标名称

当前可外放指标

`smart_money_cost`
`absolute_zones`
`liq_heatmap`
`fvg`
`cross_exchange_resonance`
`cascade_liquidation`
`retail_stop_loss`
`capital_parity_rays`
`cost_parity_bands`
`inst_vol_price_ob`
`inst_choch`
`speed_vacuum`

指标数据示例

curl -H "X-API-Key: your_api_key" "https://dash.hfd.fund/api/gateway/indicators/data?symbol=BTCUSDT&timeframe=1h&indicator=speed_vacuum"

字段	说明	备注
`code`	业务状态码	成功通常为 `0`
`message`	状态描述	成功通常为 `ok`
`data.symbol`	交易对	如 `BTCUSDT`
`data.timeframe`	周期	`30m / 1h / 4h`
`data.indicator`	指标名	不同指标代表不同含义，使用时请按各自的说明来理解
`data.updated_at`	最新更新时间	表示当前快照更新时间，不代表毫秒级实时
`data.data`	指标主体数据	不同指标的数据结构不同，使用时请分别理解

Raw Data API

原始数据 API

原始数据 API 提供更底层的信号与趋势数据，适合做深度分析、规则判断、提醒场景和进一步整理。

GET /api/gateway/raw/health 健康检查

返回原始数据服务、`signals` 表、`trends` 表与数据库整体健康状态。

GET /api/gateway/raw/meta 元信息

返回当前可用币种、周期和接口分组等元信息，适合初始化页面和能力探测。

GET /api/gateway/raw/signals 信号列表

按 `symbol + timeframe` 查询原始信号数据，支持 `limit` 与 `cursor`，适合查看最近信号和分批读取。

常用参数

`symbol`：必填
`timeframe`：必填
`limit`：可选，限制返回条数
`cursor`：可选，用于翻页

常见返回字段

`signal_type`
`timestamp_ms` / `timestamp_utc`
`total_amount_base` / `total_amount_quote`
`total_buy_*` / `total_sell_*`
`count` / `exchanges` / `created_at`

GET /api/gateway/raw/trends 趋势列表

按 `symbol + timeframe` 查询趋势级别数据，支持 `limit` 与 `cursor`，适合观察趋势变化和分批读取。

常用字段

`id` / `trend_type` / `status`
`start_time` / `last_update_time` / `end_time`
`signal_count` / `total_strength`
`avg_price` / `total_vol_coin` / `total_vol_usdt`

状态理解

`Ongoing`：趋势仍在进行中
`Completed`：趋势已完成
适合持续关注趋势变化时使用

原始信号示例

curl -H "X-API-Key: your_api_key" "https://dash.hfd.fund/api/gateway/raw/signals?symbol=BTCUSDT&timeframe=1h&limit=3"

返回格式

返回说明

列表型接口统一使用 `items + limit + has_more + next_cursor` 结构。你只需要保存并传回 `next_cursor`，不需要自己计算翻到哪一页。

字段	说明
`items`	本次分页返回的数据列表
`limit`	本次请求的条数限制
`has_more`	是否还有下一页
`next_cursor`	下一页位置标记，下一次请求时原样传回即可
`timestamp_ms`	毫秒级时间戳，适合排序和时间判断
`timestamp_utc`	可读时间，适合直接展示

列表型返回示意

{
  "code": 0,
  "data": {
    "items": [],
    "limit": 3,
    "has_more": true,
    "next_cursor": "..."
  },
  "message": "ok"
}

常见问题

错误排查

当接口返回错误时，可以优先按照下面这张表判断原因。大多数问题都集中在参数、权限、频率限制和上游数据未更新。

错误码	含义	建议处理
`0`	成功	正常消费返回数据
`40001`	参数错误	检查交易对、周期、指标名称和分页参数是否填写正确
`40101`	缺少 API Key	补充 `X-API-Key` 字段
`40102`	API Key 无效	检查 Key 是否过期、拼写是否正确
`40103`	API Key 已禁用	联系管理员重新启用或更换可用的 API Key
`40301`	当前 Key 没有对应接口权限	检查当前 Key 是否包含 `indicators` 或 `raw` 对应 scope
`40401`	资源不存在	检查路由、交易对、指标名是否存在
`42901`	超出频率或额度限制	默认最小调用间隔 `100` 秒；若返回 `retry_after_seconds`，按返回秒数后再试
`50001`	服务内部错误	稍后再试，如持续出现可联系支持
`50002`	数据库不可用	稍后重试，如持续失败请联系支持
`50003`	上游数据未准备完成	等待下一轮更新后重试

使用建议

使用说明

API 不只是“能返回数据”就够了。为了让你的产品接入后更稳定，建议提前确认安全、调用频率、更新节奏和字段变化这几件事。

安全与合规

建议始终通过安全连接访问接口。
禁止明文泄露 API Key。
不要在公开日志中记录完整的 API Key。
建议为不同环境或业务准备独立的 Key。

调用频率与额度

当前按 API Key 维度限流，不是按 IP 统一限流。
默认最小调用间隔为 `100` 秒，正式套餐默认每个 Key 每月 `15000` 次。
未开通正式 API 权益的试用额度默认总计 `10` 次。

更新节奏认知

当前数据不是毫秒级实时流。
原始数据与指标数据都基于定时更新。
适合分钟级研判、通知、展示与研究分析。

字段变化提醒

重要字段如果发生变化，建议先做兼容处理。
如果你依赖某些核心字段，建议提前留好兜底逻辑。
看到字段扩展时，优先保持兼容，不要直接假设结构固定不变。

接入方式

接入建议

如果你准备把 API 接入自己的产品，建议优先采用更稳妥的接入方式，既方便保护 API Key，也更适合做缓存和频率控制。

更稳妥的接入方式

统一保管 API Key
避免把真实凭证直接暴露出去
做好缓存和调用频率控制
把接口结果整理成更适合自己产品展示的格式

适合直接展示给用户的内容

图表展示与数据看板
通知中心与策略提醒
AI 解读与报告生成
权限控制、套餐展示和调用统计

推荐使用顺序

保存 API Key -> 请求暗流 Pro API -> 获取结果 -> 展示到你自己的网页、App 或提醒系统中

使用前准备

开始使用前，你可以先确认这些内容

如果你准备把 API 用到自己的页面、提醒工具或数据流程中，建议先确认下面这些内容。这样后面使用起来会更顺畅，也更不容易遇到权限或调用异常。

先确认你已经具备的内容

确认接口地址、版本前缀和示例路径与你当前使用的环境一致。
确认你已经拿到可用的 API Key。
先用健康检查接口测试一次，确保可以正常返回结果。

确认你要使用的数据范围

确认需要使用的接口都能正常返回。
确认数据更新节奏与你的产品预期一致。
确认你要使用的交易对、周期和指标都在可用范围内。

提前想好的使用方式

明确你的订阅方案、可用接口范围和调用频率限制。
提前做好错误重试和频率控制，避免短时间内过多请求。
妥善保管 API Key，避免在公开环境中泄露。

正式使用前的最后建议

如果你会长期使用，建议定期关注字段说明和接口更新。
如果你有提醒、看板或自动化流程，建议先在小范围内验证效果。
正式上线前，建议至少完整测试一次常用接口和错误提示是否符合预期。

暗流订阅用户API 使用知识库

快速开始

接入基础信息

访问凭证

标准时间周期

交易对格式

访问方式

当前规则

使用建议

指标 API

必填参数

当前可外放指标

原始数据 API

常用参数

常见返回字段

常用字段

状态理解

返回说明

错误排查

使用说明

安全与合规

调用频率与额度

更新节奏认知

字段变化提醒

接入建议

更稳妥的接入方式

适合直接展示给用户的内容

开始使用前，你可以先确认这些内容

先确认你已经具备的内容

确认你要使用的数据范围

提前想好的使用方式

正式使用前的最后建议

暗流订阅用户
API 使用知识库