Basics

API base URL

https://api.valuescan.io/api

Stream base URL

SSE and WebSocket push endpoints use a dedicated Stream domain:

Type	Base URL
HTTPS/SSE	https://stream.valuescan.ai
WebSocket	wss://stream.valuescan.ai

Request method

Query endpoints use POST. Parameters are sent as JSON in the request body.

SSE and WebSocket push endpoints use Stream URLs. Authentication parameters are passed via Query String when establishing the connection.

Common request headers

Header	Required	Description
Content-Type	Yes	Fixed value application/json
X-API-KEY	Yes	Your API key
X-TIMESTAMP	Yes	Current timestamp (milliseconds)
X-SIGN	Yes	Request signature
Accept	No	Recommended */* or application/json

Common response structure

All endpoints return a unified JSON structure:

{
    "code": 200,
    "message": "success",
    "data": { ... },
    "requestId": "xxx-xxx-xxx"
}

Field	Type	Description
code	integer	Status code; 200 means success, other values indicate errors
message	string	Response message; success on success, error description on failure
data	object/array	Response payload; structure varies by endpoint
requestId	string	Unique request identifier for troubleshooting

Core concepts

vsTokenId

vsTokenId is the unique token identifier in ValueScan. Most token-related endpoints require this parameter.

How to obtain:

• Call the Token list endpoint and search by token name or symbol to get the corresponding vsTokenId
• Cache frequently used vsTokenId values locally to avoid repeated lookups

Credits

Each API call consumes credits. See the Credits section in each endpoint doc for the exact amount.

Credits are the billing unit for this Open API platform and differ from in-app membership points.

Enumeration overview

Enum	Purpose	Description
BucketType	K-line time window	Second, minute, hour, day, week, month granularity
KlineType	K-line data source	Exchange source (Binance spot, futures, etc.)
TimeParticleEnum	Time period granularity	Minute through year
PriceMarketType	Price market direction	Up or down
TradeType	Trade type	Spot or futures
FundsMovementType	Fund anomaly type	Inflow/outflow and other anomaly categories
ChanceMessageType	Opportunity message type	Opportunity token message categories
RiskMessageType	Risk message type	Risk token message categories