返回首页

API 文档

所有可用的 API 接口和使用说明

📚 API 接口文档

本项目提供 RESTful API 接口，支持实时获取各大平台的热点数据。所有 API 均返回 JSON 格式数据。

v1.0

数据源 Data Sources

GET/api/v1/sources

获取所有数据源列表及其配置信息

查询参数
includeDisabled是否包含禁用的源
metrics是否包含性能指标
请求示例
curl "https://your-site.com/api/v1/sources?metrics=true"
响应示例
{
  "apiVersion": "1.0",
  "timestamp": 1703980800000,
  "count": 27,
  "sources": [
    {
      "id": "weibo",
      "name": "微博热搜",
      "home": "https://s.weibo.com",
      "type": "hot",
      "interval": 120,
      "enabled": true,
      "column": "china",
      "color": "#ff8200"
    }
  ]
}
GET/api/v1/sources/[id]

获取单个数据源的详细信息

路径参数
id数据源ID (e.g., weibo, zhihu)
请求示例
curl "https://your-site.com/api/v1/sources/weibo"
GET/api/v1/batch

批量获取多个数据源的数据

查询参数
sources逗号分隔的源ID (必填)
force强制刷新缓存
limit每源条数限制 (1-50)
请求示例
curl "https://your-site.com/api/v1/batch?sources=weibo,zhihu,baidu&limit=10"
GET/api/hot-list

获取单个数据源的热点数据（旧版）

查询参数
id数据源ID (必填)
refresh强制刷新 (true/false)
请求示例
curl "https://your-site.com/api/hot-list?id=weibo&refresh=true"
GET/api/v1/sources/hot/batch

热点数据批量获取（带并发控制）

查询参数
ids源ID列表 (逗号分隔)
concurrency并发数限制
timeout超时时间(ms)

系统监控 System Monitoring

GET/api/v1/health

系统健康检查和监控指标

功能说明
  • 系统运行状态（healthy/degraded/unhealthy）
  • 内存使用情况
  • Node.js 版本和运行时间
  • 所有数据源的健康状态
请求示例
curl "https://your-site.com/api/v1/health"
GET/api/v1/metrics

获取系统性能指标

查询参数
detailed是否返回详细指标
包含指标
  • 请求总数、错误率、平均响应时间
  • 缓存命中率
  • P95/P99 响应时间
  • 各数据源成功率和耗时
GET/api/v1/errors

获取错误统计信息

查询参数
source按数据源筛选
GET/api/v1/logs

查看系统日志

高级功能 Advanced Features

GET/api/v1/stream

流式 API - 逐步返回数据

查询参数
sources源ID列表 (必填)
chunkSize每批条目数
delay批次延迟(ms)
响应格式
{
  "type": "start|data|end|error",
  "sourceId": "weibo",
  "data": [...],
  "total": 20
}
GET/api/v1/optimized/batch

优化批量 API（优先级队列）

查询参数
sources源ID列表
priority优先级排序
concurrency并发数
GET/api/v1/security/ip-whitelist

IP 白名单管理

GET/api/latest

版本信息

💡 使用提示

所有 API 均支持 CORS，可直接在浏览器调用
数据自动缓存，使用 ?force=1 强制刷新
部分源可能因反爬虫而失败，会自动重试
建议设置 User-Agent 避免被限流

需要更多帮助？查看项目文档或联系开发者

← 返回首页