Skip to content

Quick Start

Onboarding

Step 1: API key

In the Developer Portal, obtain your API key.

Step 2: Environment

EnvironmentBase URLUse
Staginghttps://api-beta.valuescan.io/apiDevelopment and testing
Productionhttps://api.valuescan.io/apiLive

Step 3: First request

Token list example:

Request body

json
{
    "search": "BTC"
}

cURL

bash
curl --location --request POST 'https://api.valuescan.io/api/open/v1/vs-token/list' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'X-TIMESTAMP: MILLISECONDS_TIMESTAMP' \
--header 'X-SIGN: SIGNATURE' \
--data-raw '{
    "search": "BTC"
}'

Step 4: Response

json
{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": 1,
            "symbol": "BTC",
            "name": "Bitcoin"
        }
    ],
    "requestId": "xxx-xxx-xxx"
}

Core parameters

ParameterMeaningHow to get
vsTokenIdToken ID in ValueScanToken list
coinKeyOn-chain token keyToken detail

Typical flow

1. Token list → get vsTokenId

2. Token detail → coinKey and metadata

3. Data APIs → K-line, flow, on-chain, etc.

Next steps

  • Basic info for request conventions
  • Error handling for status codes
  • Per-endpoint docs for parameters and credits