Thông tin cơ bản

URL cơ sở API

https://api.valuescan.io/api

URL cơ sở Stream

Endpoint push SSE và WebSocket dùng tên miền Stream riêng:

Loại	URL cơ sở
HTTPS/SSE	https://stream.valuescan.ai
WebSocket	wss://stream.valuescan.ai

Phương thức yêu cầu

Endpoint truy vấn dùng phương thức POST. Tham số được gửi dưới dạng JSON trong request body.

Endpoint push SSE và WebSocket dùng Stream URL. Tham số xác thực được truyền qua Query String khi thiết lập kết nối.

Header yêu cầu chung

Header	Bắt buộc	Mô tả
Content-Type	Có	Giá trị cố định application/json
X-API-KEY	Có	API key của bạn
X-TIMESTAMP	Có	Timestamp hiện tại (mili giây)
X-SIGN	Có	Chữ ký yêu cầu
Accept	Không	Khuyến nghị */* hoặc application/json

Cấu trúc phản hồi chung

Tất cả endpoint trả về cấu trúc JSON thống nhất:

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

Trường	Kiểu	Mô tả
code	integer	Mã trạng thái; 200 là thành công, các giá trị khác là lỗi
message	string	Thông báo phản hồi; success khi thành công, mô tả lỗi khi thất bại
data	object/array	Dữ liệu phản hồi; cấu trúc tùy theo endpoint
requestId	string	Định danh yêu cầu duy nhất, dùng để xử lý sự cố

Khái niệm cốt lõi

vsTokenId

vsTokenId là định danh duy nhất của token trong hệ thống ValueScan. Hầu hết endpoint liên quan đến token đều yêu cầu tham số này.

Cách lấy:

• Gọi endpoint Danh sách token, tìm theo tên hoặc ký hiệu token để lấy vsTokenId tương ứng
• Nên cache các vsTokenId thường dùng cục bộ để tránh truy vấn lặp

Credits

Mỗi lần gọi API sẽ tiêu tốn Credits tương ứng. Xem mục Credits consumption trong tài liệu từng endpoint để biết số lượng cụ thể.

Credits là đơn vị tính phí của nền tảng Open API này, khác với điểm thành viên trong ứng dụng.

Tổng quan kiểu liệt kê

Kiểu liệt kê	Mục đích	Mô tả
BucketType	Cửa sổ thời gian nến	Hỗ trợ độ chi tiết giây, phút, giờ, ngày, tuần, tháng
KlineType	Nguồn dữ liệu nến	Xác định nguồn sàn giao dịch của dữ liệu nến (Binance spot, hợp đồng, v.v.)
TimeParticleEnum	Độ chi tiết chu kỳ thời gian	Hỗ trợ các chiều thời gian từ phút đến năm
PriceMarketType	Hướng thị trường giá	Tăng hoặc giảm
TradeType	Loại giao dịch	Giao ngay hoặc hợp đồng
FundsMovementType	Loại bất thường vốn	Phân loại bất thường như dòng vốn vào/ra
ChanceMessageType	Loại tin cơ hội	Phân loại tin token cơ hội
RiskMessageType	Loại tin rủi ro	Phân loại tin token rủi ro