Basic Information
Base URL
| Environment | Base URL |
|---|---|
| Staging | https://api-beta.valuescan.io/api |
| Production | https://api.valuescan.io/api |
HTTP method
All endpoints use POST with a JSON body.
Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-API-KEY | Yes | Your API key |
X-TIMESTAMP | Yes | Milliseconds since Unix epoch |
X-SIGN | Yes | Request signature |
Accept | No | Recommended */* or application/json |
Response envelope
json
{
"code": 200,
"message": "success",
"data": { ... },
"requestId": "xxx-xxx-xxx"
}| Field | Type | Description |
|---|---|---|
code | integer | 200 success; other values indicate errors |
message | string | success or error text |
data | object/array | Payload shape varies by endpoint |
requestId | string | Idempotency / support correlation |
Concepts
vsTokenId
Unique token id in ValueScan; required for most token-scoped APIs.
How to obtain
- Call Token list and search by name or symbol
- Cache frequently used ids to avoid repeat lookups
Credits
Each call consumes credits; see Credits in each endpoint doc.
Enum overview
| Enum | Role | Notes |
|---|---|---|
| BucketType | K-line interval | Second through month |
| KlineType | K-line venue | Binance spot, perps, etc. |
| TimeParticleEnum | Time bucketing | Minute through year |
| PriceMarketType | Direction | Up or down |
| TradeType | Market | Spot or contract |
| FundsMovementType | Flow anomaly kind | In/out and signal classes |
| ChanceMessageType | Opportunity message | Signal taxonomy |
| RiskMessageType | Risk message | Signal taxonomy |