Skip to content

Token list

Description

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

Use case: Resolve vsTokenId required by other token APIs.

Note: If multiple tokens match the query (different chains or standards), prompt the user to choose and cache name ↔ vsTokenId.

Update frequency: Real-time

Endpoint

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

Credits

  • Cost: 1

Prerequisites

None.

Request body (JSON)

FieldTypeRequiredDescription
searchstringNoSymbol keyword, fuzzy, max 100 chars, case-insensitive

Response — data[]

FieldTypeSerializedDescription
idlonglongToken id (vsTokenId)
symbolstringstringTicker (e.g. BTC)
namestringstringFull name (e.g. Bitcoin)

Semantics

FieldMeaningTip
idCanonical idSame as vsTokenId; cache it
symbolDisplay / confirm
nameDisambiguateWhen symbols collide

Example

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

Sample success

json
{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": 1,
            "symbol": "BTC",
            "name": "Bitcoin"
        },
        {
            "id": 33652,
            "symbol": "LBTC",
            "name": "Lombard Staked BTC"
        },
        {
            "id": 50460,
            "symbol": "SBTC",
            "name": "sBTC"
        }
    ],
    "requestId": "xxx-xxx-xxx"
}