代幣列表
介面描述
取得 ValueScan 支援的代幣列表，支援按代幣全稱或代幣簡稱進行模糊搜尋。
使用情境：這是基礎介面，用於取得代幣的 vsTokenId，該 ID 是呼叫其他代幣相關介面的必要參數。
重要提示：當使用者輸入代幣名稱時，若存在多個同名或相近的代幣（如不同鏈、不同標準），需引導使用者選擇目標代幣，並快取代幣名稱與 vsTokenId 的對應關係，以便後續介面呼叫時直接引用。
資料更新頻率：即時更新
請求 URL
- 方法：
POST - 路徑：
/open/v1/vs-token/list
點數消耗
- 消耗點數：
1
前置條件
無前置條件，可直接呼叫。
請求參數
參數透過請求體（Body）以 JSON 格式傳遞。
| 參數名 | 類型 | 必需 | 描述 |
|---|---|---|---|
| search | string | 否 | 搜尋關鍵字（符號，支援模糊匹配），最大長度100字元，大小寫不敏感 |
回應欄位
僅展示 data 陣列內每個物件的欄位結構：
| 欄位 | 類型 | 實際回傳類型 | 描述 |
|---|---|---|---|
| id | long | long | 代幣 ID（即 vsTokenId，用於其他介面呼叫） |
| symbol | string | string | 代幣符號（如 BTC, ETH） |
| name | string | string | 代幣名稱（如 Bitcoin, Ethereum） |
| icon | string | string | 代幣圖標 URL |
欄位業務含義
| 欄位 | 業務含義 | 使用建議 |
|---|---|---|
| id | 代幣唯一識別 | 回傳的 id 即為 vsTokenId，應快取此值以便後續介面呼叫 |
| symbol | 代幣交易符號 | 用於展示和使用者確認 |
| name | 代幣完整名稱 | 當多個代幣 symbol 相同時，透過 name 區分 |
| icon | 代幣圖標 URL | 用於前端展示代幣圖標 |
請求範例
json
{
"search": "btc" // 搜索关键字
}cURL 範例（Linux/macOS）
bash
curl --location --request POST 'http://${host}/api/open/v1/vs-token/list' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
"search": "btc"
}'cURL 範例（Windows CMD）
cmd
curl --location --request POST "http://${host}/api/open/v1/vs-token/list" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{ \"search\": \"btc\"}"成功回應範例
json
{
"code": 200,
"message": "success",
"data": [
{
"id": 1, // 代币ID
"symbol": "BTC", // 代币符号
"name": "Bitcoin", // 代币名称
"icon": "https://static.valuescan.io/valuescan/cmc/coins/1.png" // 代币图标
},
{
"id": 33652,
"symbol": "LBTC",
"name": "Lombard Staked BTC",
"icon": "https://static.valuescan.io/valuescan/cmc/coins/33652.png"
},
{
"id": 50460,
"symbol": "SBTC",
"name": "sBTC",
"icon": "https://static.valuescan.io/valuescan/cmc/coins/38906.png"
},
...
],
"requestId": "xxx-xxx-xxx"
}