Thông tin cơ bản
Base URL
| Môi trường | Base URL |
|---|---|
| Staging | https://api-beta.valuescan.io/api |
| Production | https://api.valuescan.io/api |
Phương thức
Mọi endpoint dùng POST với body JSON.
Header
| Header | Bắt buộc | Mô tả |
|---|---|---|
Content-Type | Có | application/json |
X-API-KEY | Có | Khóa API |
X-TIMESTAMP | Có | Unix ms |
X-SIGN | Có | Chữ ký HMAC |
Accept | Không | Nên */* hoặc application/json |
Khung phản hồi
json
{
"code": 200,
"message": "success",
"data": { ... },
"requestId": "xxx-xxx-xxx"
}| Trường | Kiểu | Mô tả |
|---|---|---|
code | int | 200 thành công |
message | string | Thông điệp |
data | object/array | Payload |
requestId | string | Trace / hỗ trợ |
Khái niệm
vsTokenId
Định danh duy nhất của token trong ValueScan; hầu hết API token yêu cầu trường này.
Lấy: gọi Danh sách token; nên cache giá trị thường dùng.
Điểm tín phí
Mỗi lần gọi trừ điểm; xem mục Điểm tín phí trong từng tài liệu API.
Liệt kê enum (tổng quan)
| Enum | Vai trò |
|---|---|
| BucketType | Khung thời gian nến |
| KlineType | Nguồn / loại nến |
| TimeParticleEnum | Bước thời gian phân tích |
| PriceMarketType | Hướng giá |
| TradeType | Spot / hợp đồng |
| FundsMovementType | Kiểu bất thường dòng tiền |
| ChanceMessageType | Tin cơ hội |
| RiskMessageType | Tin rủi ro |