Documentation Index
Fetch the complete documentation index at: https://docs.chainstream.io/llms.txt
Use this file to discover all available pages before exploring further.
官方 SDK
ChainStream 提供多種語言的官方 SDK,封裝了常用 API 操作,提供更好的開發體驗。
TypeScript
適用於 Node.js 和瀏覽器應用
SDK 功能
所有 SDK 都提供:
- REST API 客戶端:呼叫所有 ChainStream 資料 API
- WebSocket 客戶端:訂閱實時資料流
- 自動認證:自動管理 Token
- 型別安全:完整的型別定義(TypeScript、Go、Rust)
TypeScript
Python
Go
Rust
npm install @chainstream-io/sdk
pip install chainstream-sdk
go get github.com/chainstream-io/chainstream-go-sdk
# 添加到 Cargo.toml
[dependencies]
chainstream-sdk = "0.1"
快速對比
TypeScript
Python
Go
Rust
import { ChainStreamClient } from '@chainstream-io/sdk';
const client = new ChainStreamClient('YOUR_ACCESS_TOKEN');
// REST API 调用
const token = await client.token.getToken('sol', 'TOKEN_ADDRESS');
// WebSocket 订阅
client.stream.subscribeTokenCandles({
chain: 'sol',
tokenAddress: 'TOKEN_ADDRESS',
resolution: Resolution['1s'],
callback: (data) => console.log(data)
});
from chainstream import ChainStreamClient
from chainstream.stream import Resolution
client = ChainStreamClient(access_token='YOUR_ACCESS_TOKEN')
# REST API 调用
token = await client.token.get_metadata('sol', 'TOKEN_ADDRESS')
# WebSocket 订阅
await client.stream.subscribe_token_candles(
chain='sol',
token_address='TOKEN_ADDRESS',
resolution=Resolution.S1,
callback=lambda data: print(data)
)
import chainstream "github.com/chainstream-io/chainstream-go-sdk"
client, _ := chainstream.NewChainStreamClient(accessToken, &chainstream.ChainStreamClientOptions{})
// REST API 调用
resp, _ := client.Token.GetToken(ctx, "sol", "TOKEN_ADDRESS")
// WebSocket 订阅
client.Stream.SubscribeTokenCandles("sol", "TOKEN_ADDRESS", token.N1s, func(data stream.TokenCandle) {
fmt.Println(data)
}, "")
use chainstream_sdk::{ChainStreamClient, stream::{Resolution, TokenCandle}};
let client = ChainStreamClient::new("YOUR_ACCESS_TOKEN", None);
// WebSocket 订阅
client.stream.subscribe_token_candles(
"sol",
"TOKEN_ADDRESS",
Resolution::X1s,
|candle: TokenCandle| {
println!("{:?}", candle);
},
None,
).await?;
SDK vs 直接 API
| 特性 | SDK | 直接 API |
|---|
| 型別安全 | 是(TS/Go/Rust) | 否 |
| 認證管理 | 自動處理 | 手動管理 |
| 錯誤處理 | 封裝友好 | 原始 HTTP 錯誤 |
| WebSocket | 內建支援 | 需手動實現 |
| 程式碼量 | 更少 | 較多 |
| 靈活性 | 中等 | 完全靈活 |
下一步
TypeScript SDK
檢視 TypeScript 詳細文件