基礎資訊

API 基礎 URL

環境	基礎 URL
預發布環境	https://api-beta.valuescan.io/api
正式環境	https://api.valuescan.io/api

請求方式

所有介面均使用 POST 方法，請求參數以 JSON 格式置於請求本文（Body）。

通用請求標頭

請求標頭	必需	描述
Content-Type	是	固定值 application/json
X-API-KEY	是	您的 API 金鑰
X-TIMESTAMP	是	目前時間戳（毫秒）
X-SIGN	是	請求簽章
Accept	否	建議值 */* 或 application/json

通用回應結構

所有介面回傳統一的 JSON 結構：

{
    "code": 200,
    "message": "success",
    "data": { ... },
    "requestId": "xxx-xxx-xxx"
}

欄位	型別	描述
code	integer	狀態碼，200 表示成功，其餘為錯誤
message	string	回應訊息，成功為 success，失敗為錯誤描述
data	object/array	回應資料，依介面不同而結構不同
requestId	string	請求唯一識別，用於問題排查

核心概念

vsTokenId

vsTokenId 為 ValueScan 系統中代幣的唯一識別符，呼叫大多數代幣相關介面時皆需提供此參數。

取得方式：

• 呼叫「代幣列表」介面，以代幣名稱或符號搜尋取得對應的 vsTokenId
• 建議將常用的 vsTokenId 於本機快取，避免重複查詢

點數消耗

每次介面呼叫會消耗相應點數，實際數量請參考各介面文件中的「點數消耗」說明。

列舉類型概覽

列舉類型	用途	說明
BucketType	K 線時間視窗	支援秒、分鐘、小時、日、週、月級時間粒度
KlineType	K 線資料來源	標識 K 線資料之交易所來源（幣安現貨、合約等）
TimeParticleEnum	時間週期粒度	支援分鐘至年級的時間維度
PriceMarketType	價格行情方向	上漲或下跌
TradeType	交易類型	現貨或合約
FundsMovementType	資金異動類型	資金流入／流出等異動分類
ChanceMessageType	機會訊息類型	機會代幣的訊息分類
RiskMessageType	風險訊息類型	風險代幣的訊息分類