Quick start

Integration flow

Step 1: Obtain an API key

In the Console, obtain your API key.

Step 2: Confirm base URLs

Type	Base URL
API query endpoints	https://api.valuescan.io/api
SSE push endpoints	https://stream.valuescan.ai
WebSocket push endpoints	wss://stream.valuescan.ai

Step 3: Make your first request

Using the Token list endpoint as an example:

Request example

{
    "search": "BTC"
}

cURL example

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: millisecond-timestamp' \
--header 'X-SIGN: signature' \
--data-raw '{
    "search": "BTC"
}'

Step 4: Handle the response

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

Core parameters

Parameter	Description	How to obtain
vsTokenId	Unique token identifier	Via the Token list endpoint
coinKey	On-chain token identifier	Via the Token details endpoint

Typical call chain

1. Token list → obtain vsTokenId
      ↓
2. Token details → obtain token info and coinKey
      ↓
3. Business endpoints → call specific data APIs (K-line, funds, on-chain, etc.)

Next steps

• Read Basics for full API conventions
• Read Error handling for error code definitions
• Consult individual endpoint docs for detailed parameters