Token list

Description

Lists ValueScan-supported tokens with fuzzy search on full name or symbol.

Use case: Foundational endpoint to obtain vsTokenId, required by other token-related APIs.

Important: When multiple tokens match (different chains or standards), prompt the user to choose and cache name ↔ vsTokenId for later calls.

Update frequency: Real-time

Endpoint

• Method: POST
• Path: /open/v1/vs-token/list

Credits

• Cost: 1

Prerequisites

None. Can be called directly.

Request parameters

Parameters are sent as JSON in the request body.

Field	Type	Required	Description
search	string	No	Search keyword (symbol, fuzzy match), max 100 chars, case-insensitive

Response fields

Structure of each object in the data array:

Field	Type	Serialized	Description
id	long	long	Token ID (vsTokenId for other APIs)
symbol	string	string	Ticker (e.g. BTC, ETH)
name	string	string	Full name (e.g. Bitcoin, Ethereum)
icon	string	string	Token icon URL

Field semantics

Field	Meaning	Tip
id	Unique token id	Returned id is vsTokenId; cache for later calls
symbol	Trading symbol	Display and user confirmation
name	Full token name	Disambiguate when symbols collide
icon	Token icon URL	Display token icon in UI

Example

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

Success response example

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": 1,
            "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"
}