Skip to content

Token details

Description

Returns basic information for a specified token, including market data, on-chain basics, and quote data.

Use cases:

  • General token information lookup
  • Full token profile including price, market cap, supply, etc.
  • Obtain coinKey (required for on-chain data APIs)

Important: The chainAddresses array contains coinKey values for each chain where the token is issued. To query on-chain holder addresses, balance trends, etc., have the user select a target chain and cache the corresponding coinKey.

Update frequency: Real-time

Endpoint

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

Credits

  • Cost: 1

Prerequisites

Obtain vsTokenId

ConditionDescriptionHow to obtain
vsTokenId availableUse cached vsTokenId; no repeat lookupAuto-extracted from context
vsTokenId missingCall POST /vs-token/listPrerequisite API call

Request parameters

Parameters are sent as JSON in the request body.

FieldTypeRequiredDescription
vsTokenIdlongYesToken ID

Response fields

Structure of fields inside the data object:

FieldTypeSerializedDescription
vsTokenIdlongstringToken ID
namestringstringToken name
symbolstringstringToken symbol
iconstringstringToken icon URL
oldSymbolstringstringSymbol before rename
pricenumberstringCurrent price (USD)
highPricenumberstringAll-time high (USD)
lowPricenumberstringAll-time low (USD)
marketCapDominancenumberstringMarket cap dominance (%)
volume24hnumberstring24h volume (USD)
volumeChange24hnumberstring24h volume change (%)
percentChange1hnumberstring1h price change (%)
percentChange24hnumberstring24h price change (%)
percentChange7dnumberstring7d price change (%)
percentChange30dnumberstring30d price change (%)
percentChange60dnumberstring60d price change (%)
percentChange90dnumberstring90d price change (%)
marketCapnumberstringMarket cap (USD)
totalSupplynumberstringTotal supply
circulationSupplynumberstringCirculating supply
maxSupplynumberstringMax supply
costnumberstringOn-chain average holding cost (USD)
chainAddressesarrayarrayPer-chain info
    contractAddressstringstringContract address
    chainNamestringstringChain name
    holderCountintegerstringHolder address count
    transCountintegerstringTransaction count
    issueDatelonglongIssue time (ms timestamp)
    precisionstringstringDecimals
    totalSupplystringstringSupply on this chain
    coinKeystringstringOn-chain token id (important)

Field semantics

FieldMeaningTip
coinKeyUnique on-chain token idRequired for on-chain APIs (holders, balance trend, etc.); format chainName_contractAddress, e.g. BTC_BTC, eth_0x...
chainAddressesMulti-chain listSame token may exist on multiple chains; user selects chain and cache coinKey
costWhale average costAverage holding cost from large on-chain trades
iconToken icon URLDisplay token icon in UI

Example

json
{
    "vsTokenId": 1      // Token id
}

cURL (Linux/macOS)

bash
curl --location --request POST 'http://${host}/api/open/v1/vs-token/detail' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
    "vsTokenId": 1
}'

cURL (Windows CMD)

cmd
curl --location --request POST "http://${host}/api/open/v1/vs-token/detail" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{    \"vsTokenId\": 1}"

Success response example

json
{
    "code": 200,
    "message": "success",
    "data": {
        "vsTokenId": "1",                           // Token ID
        "name": "Bitcoin",                           // Token name
        "symbol": "BTC",                             // symbol
        "icon": "https://static.valuescan.io/valuescan/cmc/coins/1.png", // Token icon
        "oldSymbol": "",                              // Symbol before rename
        "price": "70559.18",                          // Price
        "highPrice": "126198.06960343386",            // ATH
        "lowPrice": "0.04864654",                     // ATL
        "marketCapDominance": "",                      // Market cap dominance
        "volume24h": "54389029990.497185",            // 24h volume
        "volumeChange24h": "15.6056",                 // 24h volume change
        "percentChange1h": "-0.09167097",              // 1h price change
        "percentChange24h": "-1.29235993",             // 24h price change
        "percentChange7d": "3.96301796",               // 7d price change
        "percentChange30d": "5.35405481",              // 30d price change
        "percentChange60d": "-23.17390208",            // 60d price change
        "percentChange90d": "-21.71414845",            // 90d price change
        "marketCap": "1412725749093.2734",             // Market cap
        "totalSupply": "20001887",                     // Total supply
        "circulationSupply": "20001887",               // Circulating supply
        "maxSupply": "21000000",                       // Max supply
        "cost": "60515.829728843657394618",            // On-chain holding cost
        "chainAddresses": [
            {
                "contractAddress": "BTC",               // Contract address
                "chainName": "BTC",                     // Chain name
                "holderCount": "55905596",              // Holder count
                "transCount": "1322741358",             // Transaction count
                "issueDate": 1230998400000,             // Issue time
                "precision": "8",                        // Decimals
                "totalSupply": "20001892",               // Supply
                "coinKey": "BTC_BTC"                     // coinKey
            }
        ]
    },
    "requestId": "xxx-xxx-xxx"
}