基础信息
API 基础 URL
| 环境 | 基础 URL |
|---|---|
| 预发布环境 | https://api-beta.valuescan.io/api |
| 正式环境 | https://api.valuescan.io/api |
请求方式
所有接口均使用 POST 方法，请求参数通过 JSON 格式在请求体（Body）中传递。
通用请求头
| 请求头 | 必需 | 描述 |
|---|---|---|
Content-Type | 是 | 固定值 application/json |
X-API-KEY | 是 | 您的 API 密钥 |
X-TIMESTAMP | 是 | 当前时间戳（毫秒） |
X-SIGN | 是 | 请求签名 |
Accept | 否 | 建议值 */* 或 application/json |
通用响应结构
所有接口返回统一的 JSON 结构：
json
{
"code": 200,
"message": "success",
"data": { ... },
"requestId": "xxx-xxx-xxx"
}| 字段 | 类型 | 描述 |
|---|---|---|
code | integer | 状态码，200 表示成功，其他值表示错误 |
message | string | 响应消息，成功时为 success，失败时为错误描述 |
data | object/array | 响应数据，根据接口不同返回不同结构 |
requestId | string | 请求唯一标识，用于问题排查 |
核心概念
vsTokenId
vsTokenId 是 ValueScan 系统中代币的唯一标识符，调用大多数代币相关接口时都需要提供此参数。
获取方式：
- 调用「代币列表」接口，通过代币名称或符号搜索获取对应的
vsTokenId - 建议将常用的
vsTokenId进行本地缓存，避免重复查询
积分消耗
每个接口调用会消耗相应的积分，具体消耗数量请参考各接口文档中的「积分消耗」说明。
枚举类型概览
| 枚举类型 | 用途 | 说明 |
|---|---|---|
| BucketType | K线时间窗口 | 支持秒、分钟、小时、日、周、月级时间粒度 |
| KlineType | K线数据来源 | 标识K线数据的交易所来源（币安现货、合约等） |
| TimeParticleEnum | 时间周期粒度 | 支持分钟到年级的时间维度 |
| PriceMarketType | 价格行情方向 | 上涨或下跌 |
| TradeType | 交易类型 | 现货或合约 |
| FundsMovementType | 资金异动类型 | 资金流入/流出等异动分类 |
| ChanceMessageType | 机会消息类型 | 机会代币的消息分类 |
| RiskMessageType | 风险消息类型 | 风险代币的消息分类 |