快速入門
接入流程
第一步:取得 API 金鑰
在「控制台」建立應用並取得 API Key。
第二步:選擇環境
| 環境 | 基礎 URL | 用途 |
|---|---|---|
| 預發布環境 | https://api-beta.valuescan.io/api | 開發測試 |
| 正式環境 | https://api.valuescan.io/api | 正式上線 |
第三步:發起第一個請求
以「代幣列表」介面為例:
請求範例
json
{
"search": "BTC"
}cURL 範例
bash
curl --location --request POST 'https://api.valuescan.io/api/open/v1/vs-token/list' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: 您的API金鑰' \
--header 'X-TIMESTAMP: 毫秒時間戳' \
--header 'X-SIGN: 簽章' \
--data-raw '{
"search": "BTC"
}'第四步:處理回應
json
{
"code": 200,
"message": "success",
"data": [
{
"id": 1,
"symbol": "BTC",
"name": "Bitcoin"
}
],
"requestId": "xxx-xxx-xxx"
}核心參數說明
| 參數 | 說明 | 取得方式 |
|---|---|---|
| vsTokenId | 代幣唯一識別 | 透過「代幣列表」介面取得 |
| coinKey | 鏈上代幣識別 | 透過「代幣資訊」介面取得 |
典型呼叫鏈路
1. 代幣列表 → 取得 vsTokenId
↓
2. 代幣資訊 → 取得代幣詳情及 coinKey
↓
3. 業務介面 → 呼叫具體資料介面(K 線、資金、鏈上等)下一步
- 閱讀「基礎資訊」了解完整介面規範
- 閱讀「錯誤處理」了解錯誤碼定義
- 查閱各介面文件取得詳細參數說明