代币列表

接口描述

获取 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）

字段业务含义

字段	业务含义	使用建议
id	代币唯一标识	返回的 id 即为 vsTokenId，应缓存此值以便后续接口调用
symbol	代币交易符号	用于展示和用户确认
name	代币完整名称	当多个代币 symbol 相同时，通过 name 区分

请求示例

{
    "search": "btc"      // 搜索关键字
}

cURL 示例（Linux/macOS）

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）

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\"}"

成功响应示例

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": 1,          // 代币ID
            "symbol": "BTC",  // 代币符号
            "name": "Bitcoin" // 代币名称
        },
        {
            "id": 33652,
            "symbol": "LBTC",
            "name": "Lombard Staked BTC"
        },
        {
            "id": 50460,
            "symbol": "SBTC",
            "name": "sBTC"
        },
        ...
    ],
    "requestId": "xxx-xxx-xxx"
}