Skip to main content

概述

ChainStream DEX WebSocket API 提供實時資料訂閱服務,支援以下資料型別:
  • K線資料 (Candles)
  • 代幣相關 (Token Series)
  • 錢包相關 (Wallet Series)
  • 排名相關 (Ranking Series)
  • 交易相關 (Trade Series)
  • 流動池相關 (DexPool Series)
基礎 URL

快速開始

1. 建立連線

首先需要建立 WebSocket 連線。WebSocket 連線需要在 URL 中透過 token 查詢引數進行認證。
如果使用 Go 或 JavaScript SDK,認證已內建處理,無需手動設定:
呼叫 subscribeXXX 方法時,SDK 會自動檢測連線狀態,如果未連線會自動建立連線,無需手動呼叫 connect()
SDK 安裝:
  • TypeScript/JavaScript: npm install @chainstream-io/sdk (npm)
  • Python: pip install chainstream-sdk (PyPI)
  • Go: go get github.com/chainstream-io/chainstream-go-sdk (GitHub)
  • Rust: 新增 chainstream-sdkCargo.toml (crates.io)

2. 訂閱資料

選擇需要的資料型別進行訂閱:

3. 處理資料

資料訂閱

K線

K線資料

實時獲取代幣價格走勢的K線圖資料。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址,例如:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN
string
必填
K線週期,支援:1m, 5m, 15m, 1h, 4h, 1d
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:volume > 1000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

代幣

代幣統計

實時獲取代幣的市場統計資料。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址,例如:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:price > 0.01
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

代幣持有者統計

實時獲取代幣持有者統計資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址,例如:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:holders > 200
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

新代幣後設資料

獲取新上市代幣的實時後設資料資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:name == “USDC”
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

新代幣資訊

獲取新建立代幣的資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

代幣供應量

實時獲取代幣的供應量和市值資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址,例如:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:supply > 1000000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

代幣流動性

實時獲取代幣的流動性統計資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:value > 1000000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

代幣最大流動性

實時獲取代幣在單個池子中的最大流動性資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:liquidityInUsd > 10000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

代幣總流動性

實時獲取代幣在所有池子中的總流動性資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:liquidityInUsd > 50000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

排名

排名的代幣統計資料

實時獲取排名代幣的市場統計資料。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
頻道型別,支援:new、trending、us_stocks、completed、graduated
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

排名的代幣持有者統計

實時獲取排名代幣的持有者統計資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
頻道型別,支援:new、trending、us_stocks、completed、graduated
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

排名的代幣供應量資料

實時獲取排名代幣的供應量和市值資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
頻道型別,支援:new、trending、us_stocks、completed、graduated
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

排名的代幣流動性資料

實時獲取排名代幣的流動性統計資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
頻道型別,支援:new、trending、us_stocks、completed、graduated
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

排名的代幣列表

實時獲取排名代幣的完整資訊列表,包括後設資料、持有者統計、供應量和市場資料。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
排名型別,支援:new、trending、us_stocks、completed、graduated
string
可選的DEX平臺,支援:pump_fun、raydium_launchpad、meteora_dynamic_bounding_curve、bonk_fun、boop_fun、moonit_fun
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

排名代幣繫結曲線

實時獲取新上市代幣的繫結曲線進度。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

錢包

錢包餘額

實時獲取錢包的餘額資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
錢包地址,例如:HN7cABqLq46Es1jh92dQQisAq662SmxELLLsHHe4YWrH
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:balance > 1000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

錢包盈虧資料(代幣級別)

實時獲取錢包的盈虧(PnL)統計資料。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
錢包地址
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:buyAmount > 1000
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

錢包盈虧資料(錢包級別)

實時獲取錢包的整體盈虧統計資料。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
錢包地址
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

交易

代幣交易

實時獲取代幣的交易事件。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
代幣合約地址,例如:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN
string
可選的過濾條件,使用Google Common Expression Language (CEL)表示式語言語法。例如:buyAmount > 100
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

錢包交易

實時獲取指定錢包的交易事件。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
錢包地址,例如:GDekof7TtgeBKJtoVpkvzPin5mvhxSDyoUY2c1FK1T3i
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

流動池

DEX 資金池餘額

實時獲取 DEX 資金池的餘額資訊。 訂閱格式
引數說明
string
必填
區塊鏈名稱,例如:sol
string
必填
資金池地址
響應資料格式
WebSocket API 返回簡短欄位名以最佳化傳輸效率,SDK 返回完整欄位名以提高程式碼可讀性。

使用示例

重連策略

推薦使用指數退避演算法進行重連:

使用限制

最佳實踐

  1. 連線管理
    • 保持單個WebSocket連線
    • 實現自動重連機制
    • 定期傳送心跳
  2. 錯誤處理
    • 實現完整的錯誤處理流程
    • 記錄詳細的錯誤日誌
    • 使用指數退避重連
  3. 效能最佳化
    • 合理控制訂閱數量
    • 實現訊息佇列機制
    • 及時清理無用訂閱

完整示例

使用 SDK 時,認證、重連、心跳等都已自動處理,推薦在生產環境中使用。