基礎資訊

API 基礎 URL

https://api.valuescan.io/api

Stream 基礎 URL

SSE 與 WebSocket 推送介面使用獨立的 Stream 網域：

類型	基礎 URL
HTTPS/SSE	https://stream.valuescan.ai
WebSocket	wss://stream.valuescan.ai

請求方式

一般查詢介面均使用 POST 方法，請求參數透過 JSON 格式在請求體（Body）中傳遞。

SSE 與 WebSocket 推送介面使用 Stream URL，並在建立連線時透過 Query String 傳遞鑑權參數。

通用請求標頭

請求標頭	必需	描述
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 進行本地快取，避免重複查詢

點數消耗

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

點數為本開放平台 API 的計費單位，與站內會員「積分」不同。

列舉類型概覽

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