mcpField
G
goldrush-streaming-api

goldrush-streaming-api

github.com/covalenthqデータ・データベース4109 回インストール34 週間前に更新
リポジトリ

goldrush-streaming-api について

リアルタイムのブロックチェーンデータを扱う開発者向けに、GraphQL の WebSocket サブスクリプションを提供します。価格、DEX ペアイベント、ウォレットアクティビティのほか、トークンやトレーダーの単発クエリにも対応します。

主な機能

  1. 01WebSocket によるリアルタイム購読
  2. 02OHLCV 価格ストリーム
  3. 03DEX ペアの作成・更新監視
  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 ストリーミング API

WebSocket 経由の GraphQL サブスクリプションによるリアルタイムのブロックチェーンデータ。OHLCV 価格フィード、DEX ペアイベント、ウォレットアクティビティをサブ秒のレイテンシで取得できます。

クイックスタート

重要： 開発環境に最適な、公式に提供されている GoldRush クライアント SDK を常に優先して使用してください。利用可能なクライアント SDK への依存を避ける必要がある、特定の要件や制約がある場合に限り、graphql-ws などの GraphQL WebSocket クライアントを使用してください。 GoldRush クライアント 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

利用可能なストリーム

ストリーミング API には、2 種類のエンドポイントがあります。

  • サブスクリプション — WebSocket によるリアルタイムのプッシュ配信。トークンまたはペアごとの OHLCV 価格ローソク足、新しい DEX ペアの作成、ペアの更新（価格／流動性／取引高）、ウォレットアクティビティのライブ配信に対応しています。
  • クエリ — GraphQL による単発のデータ取得。トークン検索とトレーダーの損益分析に対応しています。

パラメーターとレスポンススキーマを含むエンドポイントの全一覧については、endpoints.mdを参照してください。

よくあるタスク → ストリーム

タスクエンドポイント
トークンの価格ローソク足をライブ配信subscribeToOHLCVTokens
ペアの価格ローソク足をライブ配信subscribeToOHLCVPairs
新しい DEX ペアを監視subscribeToNewPairs
ペアの価格／流動性／取引高を追跡subscribeToPairUpdates
ウォレットアクティビティをストリーム配信subscribeToWalletActivity
名前／シンボルでトークンを検索searchTokens（クエリ）
トレーダーの損益を分析getTradersPnl（クエリ）

基盤 API との主な違い

項目基盤 APIストリーミング API
プロトコルREST（HTTPS）WebSocket 経由の GraphQL
チェーン名の形式eth-mainnet（ケバブケース）ETH_MAINNET（SCREAMING_SNAKE_CASE）
認証Authorization: Bearer KEYconnection_init ペイロード内の GOLDRUSH_API_KEY
データ配信リクエスト／レスポンスプッシュ型（サブスクリプション）
レイテンシブロック単位サブ秒
ユースケース履歴データ、バッチクエリリアルタイムフィード、ライブ監視

重要なルール

  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 は複数のサブスクリプションで 1 つの接続を再利用します
  8. サブスクリプションをクリーンアップします — 完了時に返された unsubscribe 関数を呼び出します。すべての接続を閉じるには disconnect() を呼び出します

価格フィードのソース

  • DEX スワップイベント — 対応する DEX 全体のオンチェーントレードから価格を算出します
  • オンチェーンオラクルフィード — 一部のチェーンで利用できる、CEX 価格集約型の超低レイテンシ価格（例：MegaETH 上の Redstone Bolt は 2.4ms の更新頻度）

リファレンスファイル

このインデックスに記載されている情報だけでは不十分な場合は、関連するリファレンスファイルを参照してください。

ファイル参照するタイミング
overview.md接続のセットアップ、対応チェーン／DEX の一覧、クイックスタートのコードサンプル、認証の詳細が必要な場合
endpoints.mdサブスクリプションまたはクエリの構築時 — 全パラメーター、レスポンススキーマ、デコード済みイベントタイプ
sdk-guide.md複数のサブスクリプション、React 連携、raw GraphQL クエリ、WebSocket の問題のトラブルシューティングに関する SDK の利用パターンが必要な場合

コメント

Markdown 対応