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.
GraphQL 端點
所有 GraphQL 查詢發往同一端點：
https://graphql.chainstream.io/graphql
| Method | Content-Type | 使用場景 |
|---|
POST | application/json | 推薦用於所有查詢 —— 支援 variables 與複雜查詢 |
GET | 查詢字串（?query=...） | 簡單查詢、瀏覽器測試、利於快取 |
生產環境請使用 POST。GET 將查詢編碼在 URL 中，存在長度限制，複雜查詢不便使用。
在 X-API-KEY 請求頭中傳入 API Key 即可完成認證。與 REST Data API 使用同一 API Key，無需單獨憑證。
必填請求頭
| Header | Value | 是否必填 |
|---|
Content-Type | application/json | 是（POST） |
X-API-KEY | cs_live_... | 是 |
請求格式
GraphQL 請求體為包含兩個欄位的 JSON 物件：
| Field | Type | 說明 |
|---|
query | string | GraphQL query 或 mutation 字串 |
variables | object | 可選，在查詢中透過 $variable 語法引用的變數 |
POST 示例
cURL
cURL (query file)
JavaScript (fetch)
Python (requests)
curl -X POST "https://graphql.chainstream.io/graphql" \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-d '{
"query": "{ Solana { DEXTrades(limit: {count: 5}, orderBy: {descending: Block_Time}) { Block { Time } Trade { Buy { Currency { MintAddress } Amount } } } } }"
}'
複雜查詢可儲存為檔案再引用：# Save query to file
cat > query.graphql << 'EOF'
{
Solana {
DEXTrades(limit: {count: 5}, orderBy: {descending: Block_Time}) {
Block { Time }
Trade {
Buy {
Currency { MintAddress }
Amount
}
}
}
}
}
EOF
# Send request
curl -X POST "https://graphql.chainstream.io/graphql" \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-d "{\"query\": \"$(cat query.graphql | tr '\n' ' ')\"}"
const response = await fetch("https://graphql.chainstream.io/graphql", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-KEY": "your_api_key",
},
body: JSON.stringify({
query: `{
Solana {
DEXTrades(limit: {count: 5}, orderBy: {descending: Block_Time}) {
Block { Time }
Trade { Buy { Currency { MintAddress } Amount } }
}
}
}`,
}),
});
const { data, extensions } = await response.json();
console.log(data.Solana.DEXTrades);
import requests
resp = requests.post(
"https://graphql.chainstream.io/graphql",
headers={
"Content-Type": "application/json",
"X-API-KEY": "your_api_key",
},
json={
"query": """{
Solana {
DEXTrades(limit: {count: 5}, orderBy: {descending: Block_Time}) {
Block { Time }
Trade { Buy { Currency { MintAddress } Amount } }
}
}
}""",
},
)
data = resp.json()
print(data["data"]["Solana"]["DEXTrades"])
GET 示例
curl -G "https://graphql.chainstream.io/graphql" \
-H "X-API-KEY: your_api_key" \
--data-urlencode 'query={ Solana { DEXTrades(limit: {count: 5}, orderBy: {descending: Block_Time}) { Block { Time } } } }'
支援的網路
將 Cube 查詢包裹在對應的 Chain Group 中以選擇網路：
| Chain Group | Blockchain | Chain ID |
|---|
Solana | Solana | — |
EVM(network: eth) | Ethereum | 1 |
EVM(network: bsc) | BNB Chain (BSC) | 56 |
# Solana
{ Solana { DEXTrades(limit: {count: 5}) { ... } } }
# Ethereum
{ EVM(network: eth) { DEXTrades(limit: {count: 5}) { ... } } }
# BSC
{ EVM(network: bsc) { DEXTrades(limit: {count: 5}) { ... } } }
響應格式
所有響應均為 JSON，結構如下：
{
"data": {
"Solana": {
"DEXTrades": [
{ "Block": { "Time": "2025-03-27T10:15:30Z" }, "..." : "..." }
]
}
},
"extensions": {
"credits": {
"total": 50,
"cubes": [
{ "cube": "DEXTrades", "credits": 50, "row_count": 5 }
]
}
}
}
| Field | 說明 |
|---|
data | 查詢結果 —— 與查詢結構一致 |
errors | 僅在存在校驗或執行錯誤時出現 |
extensions.credits.total | 本次查詢消耗的 credit 單位總計 |
extensions.credits.cubes | 按 Cube 拆分：Cube 名稱、計費 credits 與返回行數 |
在產生 credits 消耗時，響應會包含 extensions.credits 欄位。Credits 計算方式見 計費與額度。 錯誤響應
當查詢格式錯誤或執行失敗時，響應會包含 errors 陣列：
{
"data": null,
"errors": [
{
"message": "Unknown field 'InvalidField' on type 'DEXTrades'",
"locations": [{ "line": 3, "column": 5 }]
}
]
}
下一步
執行首次查詢
跟隨分步教程，在 IDE 或 cURL 中執行真實查詢。
探索 Schema
深入瞭解 25 個 Cube、欄位型別、過濾運算子與聚合函式。
