Danh sách token

Mô tả API

Lấy danh sách token được ValueScan hỗ trợ, hỗ trợ tìm kiếm mờ theo tên đầy đủ hoặc ký hiệu token.

Tình huống sử dụng: Đây là API cơ bản, dùng để lấy vsTokenId — tham số bắt buộc khi gọi các API liên quan đến token khác.

Lưu ý quan trọng: Khi người dùng nhập tên token, nếu có nhiều token trùng hoặc gần giống tên (ví dụ khác chuỗi, khác tiêu chuẩn), cần hướng dẫn người dùng chọn token mục tiêu và cache quan hệ tên token ↔ vsTokenId để các lần gọi API sau có thể dùng trực tiếp.

Tần suất cập nhật dữ liệu: Cập nhật thời gian thực

URL yêu cầu

• Phương thức: POST
• Đường dẫn: /open/v1/vs-token/list

Điểm tín phí

• Điểm tín phí mỗi lần gọi: 1

Điều kiện tiên quyết

Không có điều kiện tiên quyết, có thể gọi trực tiếp.

Tham số yêu cầu

Tham số gửi trong body dạng JSON.

Tên tham số	Kiểu	Bắt buộc	Mô tả
search	string	Không	Từ khóa tìm kiếm (ký hiệu, hỗ trợ khớp mờ), tối đa 100 ký tự, không phân biệt hoa thường

Trường phản hồi

Chỉ liệt kê cấu trúc trường của từng phần tử trong mảng data:

Trường	Kiểu	Kiểu thực tế trả về	Mô tả
id	long	long	ID token (tức vsTokenId, dùng cho các API khác)
symbol	string	string	Ký hiệu token (ví dụ BTC, ETH)
name	string	string	Tên token (ví dụ Bitcoin, Ethereum)
icon	string	string	URL biểu tượng token

Ý nghĩa nghiệp vụ

Trường	Ý nghĩa nghiệp vụ	Gợi ý sử dụng
id	Định danh duy nhất token	id trả về chính là vsTokenId, nên cache để gọi API sau
symbol	Ký hiệu giao dịch token	Dùng để hiển thị và xác nhận với người dùng
name	Tên đầy đủ token	Phân biệt khi nhiều token có cùng symbol
icon	URL biểu tượng token	Dùng để hiển thị biểu tượng token trên giao diện

Ví dụ yêu cầu

{
    "search": "btc"      // Từ khóa tìm kiếm
}

Ví dụ cURL (Linux/macOS)

curl --location --request POST 'http://${host}/api/open/v1/vs-token/list' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
    "search": "btc"
}'

Ví dụ cURL (Windows CMD)

curl --location --request POST "http://${host}/api/open/v1/vs-token/list" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{    \"search\": \"btc\"}"

Ví dụ phản hồi thành công

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": 1,          // ID token
            "symbol": "BTC",  // Ký hiệu token
            "name": "Bitcoin", // Tên token
            "icon": "https://static.valuescan.io/valuescan/cmc/coins/1.png" // Biểu tượng token
        },
        {
            "id": 33652,
            "symbol": "LBTC",
            "name": "Lombard Staked BTC",
            "icon": "https://static.valuescan.io/valuescan/cmc/coins/33652.png"
        },
        {
            "id": 50460,
            "symbol": "SBTC",
            "name": "sBTC",
            "icon": "https://static.valuescan.io/valuescan/cmc/coins/38906.png"
        },
        ...
    ],
    "requestId": "xxx-xxx-xxx"
}