mcpField
G
goldrush-streaming-api

goldrush-streaming-api

github.com/covalenthq数据与数据库4109 次安装34 周前更新
代码仓库

关于 goldrush-streaming-api

面向需要实时区块链数据的开发者，GoldRush Streaming API 通过 GraphQL WebSocket 提供订阅流和一次性查询，涵盖价格、DEX 交易对及钱包活动。

主要功能

  1. 01WebSocket 实时订阅
  2. 02提供 OHLCV 价格流
  3. 03监控 DEX 交易对创建与更新
  4. 04流式获取钱包活动
  5. 05支持代币搜索与交易者盈亏查询
  6. 06SDK 管理连接与重试

适用场景

  1. 01监控代币或交易对价格
  2. 02跟踪新建 DEX 交易对
  3. 03实时查看钱包活动
  4. 04搜索代币或分析交易者盈亏

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/covalenthq/goldrush-agent-skills --skill goldrush-streaming-api

安装后在 Claude Code 中输入/goldrush-streaming-api确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
endpoints.md
overview.md
sdk-guide.md

详细介绍

GoldRush Streaming API

通过 WebSocket 上的 GraphQL 订阅获取实时区块链数据。OHLCV 价格流、DEX 交易对事件和钱包活动的延迟低于 1 秒。

快速入门

重要： 始终优先使用最适合你的开发生态系统的官方 GoldRush Client SDK。只有在有特定需求或限制，必须避免依赖现有 Client SDK 时，才使用 graphql-ws 等 GraphQL WebSocket 客户端。 GoldRush Client SDK 可为所有流式操作提供自动身份验证、连接管理、重试逻辑、类型安全和简化的 API。有关详情，请参阅 SDK 指南。

import {
  GoldRushClient,
  StreamingChain,
  StreamingInterval,
  StreamingTimeframe
} from "@covalenthq/client-sdk";

const client = new GoldRushClient(
  "YOUR_API_KEY",
  {},
  {
    onConnecting: () => console.log("Connecting..."),
    onOpened: () => console.log("Connected!"),
    onError: (error) => console.error("Error:", error),
  }
);

client.StreamingService.subscribeToOHLCVTokens(
  {
    chain_name: StreamingChain.BASE_MAINNET,
    token_addresses: ["0x0b3e328455c4059EEb9e3f84b5543F74E24e7E1b"],
    interval: StreamingInterval.ONE_MINUTE,
    timeframe: StreamingTimeframe.ONE_HOUR,
  },
  {
    next: (data) => console.log("OHLCV:", data),
    error: (error) => console.error(error),
    complete: () => console.log("Done"),
  }
);

安装： npm install @covalenthq/client-sdk

可用的数据流

Streaming API 提供两种端点：

  • 订阅 — 通过 WebSocket 实时推送。涵盖 OHLCV 价格蜡烛图（按代币或交易对）、新建 DEX 交易对、交易对更新（价格／流动性／交易量）以及实时钱包活动。
  • 查询 — 一次性 GraphQL 获取。涵盖代币搜索和交易者 PnL 分析。

有关端点、参数和响应架构的完整列表，请参阅 endpoints.md。

常见任务 → 数据流

任务端点
实时代币价格蜡烛图subscribeToOHLCVTokens
实时交易对价格蜡烛图subscribeToOHLCVPairs
监控新建的 DEX 交易对subscribeToNewPairs
跟踪交易对价格／流动性／交易量subscribeToPairUpdates
流式获取钱包活动subscribeToWalletActivity
按名称／符号搜索代币searchTokens（查询）
分析交易者 PnLgetTradersPnl（查询）

与 Foundational API 的主要区别

方面Foundational APIStreaming API
协议REST（HTTPS）基于 WebSocket 的 GraphQL
链名称格式eth-mainnet（kebab-case）ETH_MAINNET（SCREAMING_SNAKE_CASE）
身份验证Authorization: Bearer KEYconnection_init 负载中的 GOLDRUSH_API_KEY
数据传递请求／响应推送式（订阅）
延迟逐区块低于 1 秒
使用场景历史数据、批量查询实时数据流、实时监控

重要规则

  1. 链名称使用 SCREAMING_SNAKE_CASE — ETH_MAINNET，而非 eth-mainnet
  2. WebSocket URL — wss://streaming.goldrushdata.com/graphql
  3. 协议标头 — Sec-WebSocket-Protocol: graphql-transport-ws
  4. 身份验证负载 — { "type": "connection_init", "payload": { "GOLDRUSH_API_KEY": "YOUR_KEY" } }
  5. 身份验证错误会延迟出现 — connection_ack 始终成功；只有在开始订阅时才会出现身份验证错误
  6. 建议使用 SDK — 自动处理 WebSocket 生命周期、重新连接和类型安全
  7. WebSocket 单例 — SDK 会为多个订阅复用一个连接
  8. 清理订阅 — 完成后调用返回的取消订阅函数；调用 disconnect() 以关闭所有订阅

价格流来源

  • DEX 交换事件 — 根据所支持 DEX 上的链上交易推导价格
  • 链上预言机数据流 — 在部分链上提供超低延迟、由 CEX 聚合的价格（例如，MegaETH 上的 Redstone Bolt 更新频率为 2.4ms）

参考文件

需要了解此索引未提供的详情时，请阅读相关参考文件。

文件何时阅读
overview.md需要了解连接设置、支持的链／DEX 列表、快速入门代码示例或身份验证详情时
endpoints.md构建订阅或查询时——完整参数、响应架构和已解码事件类型
sdk-guide.md需要了解多个订阅、React 集成、原始 GraphQL 查询或 WebSocket 问题排查的 SDK 用法模式时

评论

支持 Markdown