Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 endpoint 15 nhóm X-Quota-* trên mỗi lệnh gọi http://localhost/api/v1

Tất cả endpoint nằm dưới /api/v1 và yêu cầu một Bearer key có quyền data-api — hãy tạo một key trong bảng điều khiển nhà phát triển của bạn.

Lệnh gọi đầu tiên của bạn:

curl https://bitculator.com/api/v1/prices/bitcoin \
  -H "Authorization: Bearer YOUR_API_KEY"

Phản hồi ở định dạng JSON. Giá, tỷ giá và nguồn cung là chuỗi thập phân (số float không thể mang độ chính xác của thị trường); các giá trị đếm và phân tích là số. Mỗi phản hồi mang theo hạn ngạch trực tiếp của bạn trong các header X-Quota-Limit / X-Quota-Used / X-Quota-Reset, và lỗi luôn dùng envelope {"error": {"code", "message", "details"}}.

Data API có hạn ngạch hàng tháng riêng, gắn với gói API của bạn và hoàn toàn tách biệt với các widget embed. Giới hạn per_page tùy theo gói (Free 100, Starter/Pro 250); vượt quá một giới hạn sẽ trả về 422 thay vì cắt bớt.

Xác thực

Để xác thực các request, hãy đính kèm header Authorization: Bearer {YOUR_API_KEY} trên mỗi request.

Hãy tạo một Data API key trong bảng điều khiển nhà phát triển của bạn — key chỉ dùng Bearer và mang quyền data-api. Hãy giữ chúng ở phía máy chủ; chúng không bao giờ dành cho việc nhúng ở phía client.

Header ủy quyền
Tạo một key →
Bearer
bc_••••••••••••••••

Được gửi dưới dạng Authorization: Bearer {YOUR_API_KEY} trên mỗi request.

9 endpoint

Coin

Dữ liệu thị trường coin và token đã xếp hạng: danh sách phân trang, chi tiết từng coin, biến động (gainers/losers), mới thêm gần đây, xu hướng, và chuỗi thời gian theo từng coin. Giá, vốn hóa và nguồn cung là CHUỖI thập phân (số float không thể mang độ chính xác của thị trường); thay đổi phần trăm, xếp hạng và số đếm là số.

Danh sách coin

Các coin đã xếp hạng cùng giá, bộ lọc và bộ chọn, phân trang với envelope links + meta của Laravel. Giá, marketcap và circulating_supply là chuỗi thập phân; thay đổi và xếp hạng là số.

GET
http://localhost/api/v1/coins
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
coin

Giới hạn ở một loại tài sản duy nhất: coin hoặc token.

Một trong: coin token

status
string tùy chọn
active

Trạng thái niêm yết: active, delisted, untracked, progressing, awaiting hoặc preparing. Mặc định là tất cả trạng thái công khai.

Một trong: active delisted untracked progressing awaiting preparing

search
string tùy chọn
bitcoin

Khớp văn bản tự do theo tên hoặc ký hiệu. Không được vượt quá 100 ký tự.

min_price
number tùy chọn
0.5

Chỉ những coin có giá bằng hoặc cao hơn giá trị USD này. Phải ít nhất là 0.

max_price
number tùy chọn
100000

Chỉ những coin có giá bằng hoặc thấp hơn giá trị USD này. Phải ít nhất là 0.

min_marketcap
number tùy chọn
1000000

Chỉ những coin có vốn hóa USD bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_marketcap
number tùy chọn
5000000000000

Chỉ những coin có vốn hóa USD bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những coin có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những coin có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
38,39

Lọc đến các ID coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp với slugs/symbols). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Lọc đến các slug coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp). Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Lọc đến các ký hiệu coin cụ thể (CSV, không phân biệt hoa thường, tối đa 100 bộ chọn kết hợp). Không được vượt quá 1000 ký tự.

sort
string tùy chọn
-marketcap

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: marketcap, rank, price, volume_24h, change_24h, change_7d. Không được vượt quá 100 ký tự.

interval
string tùy chọn
24h

Khoảng biến động chỉ dành cho /coins/gainers và /coins/losers: 24h hoặc 7d.

Một trong: 24h 7d

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Coin mới thêm gần đây

Những coin niêm yết mới nhất — sắp xếp theo status_updated_at (dấu thời gian chuyển sang active; created_at là ngày thu thập, thường sớm hơn ngày niêm yết một khoảng tùy ý). Cùng cấu trúc dòng và envelope phân trang như List coins.

GET
http://localhost/api/v1/coins/recently-added
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
coin

Giới hạn ở một loại tài sản duy nhất: coin hoặc token.

Một trong: coin token

status
string tùy chọn
active

Trạng thái niêm yết: active, delisted, untracked, progressing, awaiting hoặc preparing. Mặc định là tất cả trạng thái công khai.

Một trong: active delisted untracked progressing awaiting preparing

search
string tùy chọn
bitcoin

Khớp văn bản tự do theo tên hoặc ký hiệu. Không được vượt quá 100 ký tự.

min_price
number tùy chọn
0.5

Chỉ những coin có giá bằng hoặc cao hơn giá trị USD này. Phải ít nhất là 0.

max_price
number tùy chọn
100000

Chỉ những coin có giá bằng hoặc thấp hơn giá trị USD này. Phải ít nhất là 0.

min_marketcap
number tùy chọn
1000000

Chỉ những coin có vốn hóa USD bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_marketcap
number tùy chọn
5000000000000

Chỉ những coin có vốn hóa USD bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những coin có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những coin có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
38,39

Lọc đến các ID coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp với slugs/symbols). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Lọc đến các slug coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp). Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Lọc đến các ký hiệu coin cụ thể (CSV, không phân biệt hoa thường, tối đa 100 bộ chọn kết hợp). Không được vượt quá 1000 ký tự.

sort
string tùy chọn
-marketcap

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: marketcap, rank, price, volume_24h, change_24h, change_7d. Không được vượt quá 100 ký tự.

interval
string tùy chọn
24h

Khoảng biến động chỉ dành cho /coins/gainers và /coins/losers: 24h hoặc 7d.

Một trong: 24h 7d

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/recently-added?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tăng giá mạnh nhất

Những coin tăng mạnh nhất trong khoảng interval (mặc định 24h, hoặc 7d). Cùng cấu trúc dòng và envelope phân trang như List coins.

GET
http://localhost/api/v1/coins/gainers
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
coin

Giới hạn ở một loại tài sản duy nhất: coin hoặc token.

Một trong: coin token

status
string tùy chọn
active

Trạng thái niêm yết: active, delisted, untracked, progressing, awaiting hoặc preparing. Mặc định là tất cả trạng thái công khai.

Một trong: active delisted untracked progressing awaiting preparing

search
string tùy chọn
bitcoin

Khớp văn bản tự do theo tên hoặc ký hiệu. Không được vượt quá 100 ký tự.

min_price
number tùy chọn
0.5

Chỉ những coin có giá bằng hoặc cao hơn giá trị USD này. Phải ít nhất là 0.

max_price
number tùy chọn
100000

Chỉ những coin có giá bằng hoặc thấp hơn giá trị USD này. Phải ít nhất là 0.

min_marketcap
number tùy chọn
1000000

Chỉ những coin có vốn hóa USD bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_marketcap
number tùy chọn
5000000000000

Chỉ những coin có vốn hóa USD bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những coin có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những coin có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
38,39

Lọc đến các ID coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp với slugs/symbols). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Lọc đến các slug coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp). Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Lọc đến các ký hiệu coin cụ thể (CSV, không phân biệt hoa thường, tối đa 100 bộ chọn kết hợp). Không được vượt quá 1000 ký tự.

sort
string tùy chọn
-marketcap

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: marketcap, rank, price, volume_24h, change_24h, change_7d. Không được vượt quá 100 ký tự.

interval
string tùy chọn
24h

Khoảng biến động chỉ dành cho /coins/gainers và /coins/losers: 24h hoặc 7d.

Một trong: 24h 7d

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/gainers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Giảm giá mạnh nhất

Những coin giảm mạnh nhất trong khoảng interval (mặc định 24h, hoặc 7d). Cùng cấu trúc dòng và envelope phân trang như List coins.

GET
http://localhost/api/v1/coins/losers
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
coin

Giới hạn ở một loại tài sản duy nhất: coin hoặc token.

Một trong: coin token

status
string tùy chọn
active

Trạng thái niêm yết: active, delisted, untracked, progressing, awaiting hoặc preparing. Mặc định là tất cả trạng thái công khai.

Một trong: active delisted untracked progressing awaiting preparing

search
string tùy chọn
bitcoin

Khớp văn bản tự do theo tên hoặc ký hiệu. Không được vượt quá 100 ký tự.

min_price
number tùy chọn
0.5

Chỉ những coin có giá bằng hoặc cao hơn giá trị USD này. Phải ít nhất là 0.

max_price
number tùy chọn
100000

Chỉ những coin có giá bằng hoặc thấp hơn giá trị USD này. Phải ít nhất là 0.

min_marketcap
number tùy chọn
1000000

Chỉ những coin có vốn hóa USD bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_marketcap
number tùy chọn
5000000000000

Chỉ những coin có vốn hóa USD bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những coin có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những coin có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
38,39

Lọc đến các ID coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp với slugs/symbols). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Lọc đến các slug coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp). Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Lọc đến các ký hiệu coin cụ thể (CSV, không phân biệt hoa thường, tối đa 100 bộ chọn kết hợp). Không được vượt quá 1000 ký tự.

sort
string tùy chọn
-marketcap

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: marketcap, rank, price, volume_24h, change_24h, change_7d. Không được vượt quá 100 ký tự.

interval
string tùy chọn
24h

Khoảng biến động chỉ dành cho /coins/gainers và /coins/losers: 24h hoặc 7d.

Một trong: 24h 7d

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/losers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy chi tiết coin

Hồ sơ đầy đủ của một coin. Ngoài các trường trong danh sách, nó bổ sung: supply (cung lưu thông/tổng/tối đa), OHLC today, all_time_high / all_time_low (giá, ngày và phần trăm so với giá hiện tại), fully_diluted_valuation, counts thị trường (exchanges/pairs/tickers/wallets), decimals, genesis_date, links chính thức (danh sách url có kiểu), contracts token, và một description HTML đã bản địa hóa (dự phòng về tiếng Anh khi thiếu locale được yêu cầu). Tất cả các trường giá/nguồn cung là chuỗi thập phân.

GET
http://localhost/api/v1/coins/{slug}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Tham số truy vấn

locale
string tùy chọn
en

Ngôn ngữ nội dung cho phần mô tả (dự phòng về tiếng Anh).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lịch sử nến

Chuỗi thời gian OHLC + khối lượng + vốn hóa theo từng coin. Chọn interval: minutely, half-hourly, hourly hoặc daily. Thời gian lưu giữ là thuộc tính cố định của pipeline gộp — minutely 8 ngày, half-hourly 3 tháng, hourly 6 tháng, daily vĩnh viễn; yêu cầu vượt quá một cửa sổ sẽ trả về những gì đang có. Khi đặt limit bạn nhận được N dòng GẦN ĐÂY NHẤT trong cửa sổ, phát ra theo thứ tự cũ nhất trước. Giá là chuỗi thập phân.

GET
http://localhost/api/v1/coins/{slug}/history
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Tham số truy vấn

interval
string tùy chọn
daily

minutely, half-hourly, hourly hoặc daily (mặc định daily).

start
string tùy chọn
2026-06-01

Giới hạn dưới ngày/giờ dạng ISO.

end
string tùy chọn
2026-06-30

Giới hạn trên ngày/giờ dạng ISO (giá trị chỉ có ngày nghĩa là tính đến hết ngày đó).

limit
integer tùy chọn
30

Số dòng tối đa (1–2000, mặc định 1000).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lịch sử vốn hóa thị trường

Cùng các số liệu gộp theo từng coin như Candle history, chỉ chiếu đến {time, marketcap}. Cùng các lựa chọn interval và cửa sổ lưu giữ (minutely 8 ngày, half-hourly 3 tháng, hourly 6 tháng, daily vĩnh viễn), N gần đây nhất khi đặt limit.

GET
http://localhost/api/v1/coins/{slug}/marketcap-history
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Tham số truy vấn

interval
string tùy chọn
daily

minutely, half-hourly, hourly hoặc daily (mặc định daily).

start
string tùy chọn
2026-06-01

Giới hạn dưới ngày/giờ dạng ISO.

end
string tùy chọn
2026-06-30

Giới hạn trên ngày/giờ dạng ISO.

limit
integer tùy chọn
30

Số dòng tối đa (1–2000, mặc định 1000).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/marketcap-history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sparkline của coin

Một chuỗi giá gọn nhẹ cho coin trong khoảng period đã chọn, dùng để vẽ sparkline.

GET
http://localhost/api/v1/coins/{slug}/sparkline
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Tham số truy vấn

period
string tùy chọn
7d

24h, 7d, 30d, 60d, 90d, 180d hoặc 365d (mặc định 7d).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoint

Giá

Đường dẫn giá nhẹ tốc độ cao — giá hiện tại, vốn hóa, khối lượng 24h và các thay đổi gần đây cho một tập hợp coin được yêu cầu. /prices yêu cầu một bộ chọn (ids, slugs hoặc symbols); /prices/{slug} nhắm đến một coin. Tùy chọn convert sang một loại tiền tệ fiat (giá crypto làm mới ~mỗi phút, tỷ giá fiat ~hai lần mỗi ngày). Giá và vốn hóa là chuỗi thập phân.

Lấy giá

Giá cho một tập hợp coin được yêu cầu. Truyền ít nhất một bộ chọn — ids, slugs hoặc symbols (tối đa 100 kết hợp). meta.currency phản ánh đích chuyển đổi (USD trừ khi convert được đặt).

GET
http://localhost/api/v1/prices
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

ids
string tùy chọn
38,39

ID coin cần định giá (CSV). Cần ít nhất một trong ids, slugs hoặc symbols; ba danh sách giới hạn tổng cộng 100 bộ chọn. Trường này bắt buộc khi không có slugssymbols. Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Slug coin cần định giá (CSV). Cần ít nhất một trong ids, slugs hoặc symbols. Trường này bắt buộc khi không có idssymbols. Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Ký hiệu coin cần định giá (CSV, không phân biệt hoa thường). Cần ít nhất một trong ids, slugs hoặc symbols. Trường này bắt buộc khi không có idsslugs. Không được vượt quá 1000 ký tự.

convert
string tùy chọn
EUR

Chuyển đổi giá/vốn hóa thị trường sang một loại tiền tệ fiat đang hoạt động theo ký hiệu (mặc định USD). Tỷ giá làm mới ~hai lần mỗi ngày.

Một trong: USD EUR JPY BGN CZK DKK GBP HUF PLN RON SEK CHF ISK NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR ILS INR KRW MXN MYR NZD PHP SGD THB ZAR ARS DZD MAD TWD

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/prices?ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy giá một coin

Ảnh chụp giá của một coin. Tùy chọn convert sang một loại tiền tệ fiat đang hoạt động theo ký hiệu (mặc định USD).

GET
http://localhost/api/v1/prices/{slug}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Tham số truy vấn

convert
string tùy chọn
EUR

Ký hiệu tiền tệ fiat đang hoạt động để định giá (mặc định USD).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/prices/bitcoin?convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Giá lịch sử

Giá USD của coin vào một ngày nhất định, đọc từ lịch sử hàng ngày (đúng ngày, dự phòng ±3 ngày — cùng bộ giải mà danh mục đầu tư sử dụng). Chỉ crypto: các dòng fiat không có lịch sử hàng ngày.

GET
http://localhost/api/v1/historical-price
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

date
string bắt buộc
2021-04-14

date Ngày tra cứu (sau 2008-12-31, không ở tương lai).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/historical-price?slug=bitcoin&date=2021-04-14" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoint

Thị trường

Ticker (thị trường theo từng sàn) và cặp (thị trường tổng hợp theo nơi giao dịch), cùng thị trường của một coin và các ký hiệu giao dịch thô theo từng sàn. Tất cả đều là dữ liệu ảnh chụp — không tồn tại lịch sử theo từng ticker/cặp. Khối lượng USD là số; giá là chuỗi thập phân.

Thị trường của coin

Tất cả thị trường của một coin — các ticker có cặp chứa coin làm tài sản cơ sở HOẶC định giá. Cùng cấu trúc dòng và bộ lọc như List tickers.

GET
http://localhost/api/v1/coins/{slug}/markets
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

exchange
string tùy chọn
binance-exchange

Giới hạn ở một sàn giao dịch duy nhất theo slug (bỏ trống trên danh sách theo từng sàn, vốn đã được giới hạn phạm vi). Phải khớp regex /^[a-z0-9-]{1,120}$/.

pair
integer tùy chọn
1

Giới hạn ở một cặp duy nhất theo id. Phải ít nhất là 1.

instrument
string tùy chọn
spot

Loại công cụ: future, option, swap, spot hoặc margin (chấp nhận dạng số nhiều).

Một trong: future option swap spot margin

search
string tùy chọn
BTC

Khớp văn bản tự do theo ký hiệu ticker. Không được vượt quá 50 ký tự.

min_volume
number tùy chọn
1000000

Chỉ những ticker có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những ticker có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_change
number tùy chọn
-50

Chỉ những ticker có phần trăm thay đổi 24h bằng hoặc cao hơn giá trị này.

max_change
number tùy chọn
50

Chỉ những ticker có phần trăm thay đổi 24h bằng hoặc thấp hơn giá trị này.

sort
string tùy chọn
-volume_usd

Một trường sắp xếp duy nhất (thêm tiền tố - để giảm dần). Có thể sắp xếp: volume_usd, change_24h, price_usd, updated. Mặc định là -volume_usd. Không được vượt quá 100 ký tự.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/markets?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Ký hiệu giao dịch của coin

Các ký hiệu giao dịch thô theo từng sàn của coin — dữ liệu tham chiếu điền thưa (phạm vi ở mức nỗ lực tối đa).

GET
http://localhost/api/v1/coins/{slug}/symbols
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/symbols" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Danh sách ticker

Các thị trường riêng lẻ theo từng sàn (ticker), có phân trang. Lọc theo exchange, pair, instrument và các khoảng khối lượng/thay đổi. Khối lượng USD là số; giá là chuỗi thập phân.

GET
http://localhost/api/v1/tickers
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

exchange
string tùy chọn
binance-exchange

Giới hạn ở một sàn giao dịch duy nhất theo slug (bỏ trống trên danh sách theo từng sàn, vốn đã được giới hạn phạm vi). Phải khớp regex /^[a-z0-9-]{1,120}$/.

pair
integer tùy chọn
1

Giới hạn ở một cặp duy nhất theo id. Phải ít nhất là 1.

instrument
string tùy chọn
spot

Loại công cụ: future, option, swap, spot hoặc margin (chấp nhận dạng số nhiều).

Một trong: future option swap spot margin

search
string tùy chọn
BTC

Khớp văn bản tự do theo ký hiệu ticker. Không được vượt quá 50 ký tự.

min_volume
number tùy chọn
1000000

Chỉ những ticker có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những ticker có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_change
number tùy chọn
-50

Chỉ những ticker có phần trăm thay đổi 24h bằng hoặc cao hơn giá trị này.

max_change
number tùy chọn
50

Chỉ những ticker có phần trăm thay đổi 24h bằng hoặc thấp hơn giá trị này.

sort
string tùy chọn
-volume_usd

Một trường sắp xếp duy nhất (thêm tiền tố - để giảm dần). Có thể sắp xếp: volume_usd, change_24h, price_usd, updated. Mặc định là -volume_usd. Không được vượt quá 100 ký tự.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Danh sách cặp

Các cặp giao dịch tổng hợp theo nơi giao dịch, xếp hạng theo khối lượng USD 24h. Lọc theo một slug coin (cơ sở hoặc định giá) và khoảng khối lượng.

GET
http://localhost/api/v1/pairs
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

search
string tùy chọn
BTC

Khớp văn bản tự do theo ký hiệu cặp. Không được vượt quá 50 ký tự.

coin
string tùy chọn
bitcoin

Giới hạn ở các cặp trong đó slug coin này là tài sản cơ sở hoặc định giá. Phải khớp regex /^[a-z0-9-]{1,120}$/.

min_volume
number tùy chọn
1000000

Chỉ những cặp có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những cặp có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

sort
string tùy chọn
-volume_usd

Trường sắp xếp: volume_usd hoặc updated (thêm tiền tố - để giảm dần). Mặc định là -volume_usd.

Một trong: volume_usd -volume_usd updated -updated

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/pairs?page=1&per_page=50&search=BTC&coin=bitcoin&min_volume=1000000&max_volume=100000000000&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy chi tiết cặp

Một cặp cùng mọi ticker sàn giao dịch niêm yết nó, sắp xếp theo khối lượng.

GET
http://localhost/api/v1/pairs/{id}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
1

ID của cặp.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/pairs/1" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
7 endpoint

Sàn giao dịch

Xếp hạng sàn giao dịch, chi tiết, điểm tin cậy, chuỗi thời gian và danh sách thị trường/coin theo từng sàn. Khối lượng tính bằng USD. Không có cột CEX/DEX — type được suy ra từ phân loại sàn giao dịch, nên nó có thể là "cex", "dex" hoặc null.

Danh sách sàn giao dịch

Các sàn giao dịch đã xếp hạng cùng khối lượng 24h, ưu thế, số lượng cặp/tài sản và các thay đổi gần đây. Phân trang với envelope links + meta của Laravel.

GET
http://localhost/api/v1/exchanges
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
cex

Giới hạn ở một loại nơi giao dịch: cex hoặc dex (được xác định qua phân loại sàn giao dịch).

Một trong: cex dex

search
string tùy chọn
binance

Khớp văn bản tự do theo tên sàn giao dịch. Không được vượt quá 100 ký tự.

min_pairs
integer tùy chọn
100

Chỉ những sàn giao dịch niêm yết ít nhất số cặp này. Phải ít nhất là 0.

max_pairs
integer tùy chọn
2000

Chỉ những sàn giao dịch niêm yết nhiều nhất số cặp này. Phải ít nhất là 0.

min_assets
integer tùy chọn
50

Chỉ những sàn giao dịch niêm yết ít nhất số tài sản này. Phải ít nhất là 0.

max_assets
integer tùy chọn
1000

Chỉ những sàn giao dịch niêm yết nhiều nhất số tài sản này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những sàn giao dịch có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những sàn giao dịch có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
1,12

Lọc đến các ID sàn giao dịch cụ thể (CSV, tối đa 100). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
binance-exchange,gateio

Lọc đến các slug sàn giao dịch cụ thể (CSV, tối đa 100). Không được vượt quá 2000 ký tự.

sort
string tùy chọn
-volume

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: volume, rank, volume_dominance, change_24h, change_7d, pairs, assets. Không được vượt quá 100 ký tự.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges?page=1&per_page=50&type=cex&search=binance&min_pairs=100&max_pairs=2000&min_assets=50&max_assets=1000&min_volume=1000000&max_volume=100000000000&ids=1%2C12&slugs=binance-exchange%2Cgateio&sort=-volume" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy chi tiết sàn giao dịch

Hồ sơ đầy đủ của một sàn giao dịch: xếp hạng, khối lượng/ưu thế, số lượng cặp và tài sản, ngày established, location, website giới thiệu, và type được suy ra (cex/dex/null).

GET
http://localhost/api/v1/exchanges/{slug}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
binance-exchange

Slug của sàn giao dịch.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy điểm tin cậy của sàn giao dịch

Một score tin cậy tổng hợp từ 0–10 cùng breakdown 13 yếu tố của nó (rank, volume, age, volume_trend, stability, rank_stability, ticker_health, pairs, community, assets, dominance, market_breadth, transparency). Được tính cho mỗi sàn giao dịch và cache trong 24h.

GET
http://localhost/api/v1/exchanges/{slug}/trust-score
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
binance-exchange

Slug của sàn giao dịch.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/trust-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lịch sử sàn giao dịch

Chuỗi thời gian khối lượng / ưu thế / cặp / tài sản (các số liệu gộp của sàn không mang OHLC). Chọn interval: minutely, hourly hoặc daily. Thời gian lưu giữ là thuộc tính cố định của pipeline gộp — minutely 8 ngày, hourly 6 tháng, daily vĩnh viễn; khi đặt limit bạn nhận được N dòng gần đây nhất trong cửa sổ, cũ nhất trước.

GET
http://localhost/api/v1/exchanges/{slug}/history
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
binance-exchange

Slug của sàn giao dịch.

Tham số truy vấn

interval
string tùy chọn
daily

minutely, hourly hoặc daily (mặc định daily).

start
string tùy chọn
2026-06-01

Giới hạn dưới ngày/giờ dạng ISO.

end
string tùy chọn
2026-06-30

Giới hạn trên ngày/giờ dạng ISO (giá trị chỉ có ngày nghĩa là tính đến hết ngày đó).

limit
integer tùy chọn
30

Số dòng tối đa (1–2000, mặc định 1000).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sparkline của sàn giao dịch

Chuỗi sparkline khối lượng của sàn giao dịch cho một khoảng thời gian (mặc định 7d) — cùng chuỗi mà các dòng sàn giao dịch trên web hiển thị.

GET
http://localhost/api/v1/exchanges/{slug}/sparkline
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
binance-exchange

Slug của sàn giao dịch.

Tham số truy vấn

period
string tùy chọn
7d

Một trong 24h, 7d (mặc định), 30d, 60d, 90d, 180d, 365d.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Thị trường của sàn giao dịch

Danh sách ticker của sàn giao dịch (các thị trường của nó), có phân trang. Đã được giới hạn phạm vi theo sàn — không truyền tham số exchange ở đây.

GET
http://localhost/api/v1/exchanges/{slug}/tickers
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
binance-exchange

Slug của sàn giao dịch.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

exchange
string tùy chọn
binance-exchange

Giới hạn ở một sàn giao dịch duy nhất theo slug (bỏ trống trên danh sách theo từng sàn, vốn đã được giới hạn phạm vi). Phải khớp regex /^[a-z0-9-]{1,120}$/.

pair
integer tùy chọn
1

Giới hạn ở một cặp duy nhất theo id. Phải ít nhất là 1.

instrument
string tùy chọn
spot

Loại công cụ: future, option, swap, spot hoặc margin (chấp nhận dạng số nhiều).

Một trong: future option swap spot margin

search
string tùy chọn
BTC

Khớp văn bản tự do theo ký hiệu ticker. Không được vượt quá 50 ký tự.

min_volume
number tùy chọn
1000000

Chỉ những ticker có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những ticker có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_change
number tùy chọn
-50

Chỉ những ticker có phần trăm thay đổi 24h bằng hoặc cao hơn giá trị này.

max_change
number tùy chọn
50

Chỉ những ticker có phần trăm thay đổi 24h bằng hoặc thấp hơn giá trị này.

sort
string tùy chọn
-volume_usd

Một trường sắp xếp duy nhất (thêm tiền tố - để giảm dần). Có thể sắp xếp: volume_usd, change_24h, price_usd, updated. Mặc định là -volume_usd. Không được vượt quá 100 ký tự.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Coin của sàn giao dịch

Các coin được niêm yết trên sàn giao dịch, trả về cùng cấu trúc như List coins và chấp nhận cùng bộ lọc/sắp xếp.

GET
http://localhost/api/v1/exchanges/{slug}/assets
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
binance-exchange

Slug của sàn giao dịch.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
coin

Giới hạn ở một loại tài sản duy nhất: coin hoặc token.

Một trong: coin token

status
string tùy chọn
active

Trạng thái niêm yết: active, delisted, untracked, progressing, awaiting hoặc preparing. Mặc định là tất cả trạng thái công khai.

Một trong: active delisted untracked progressing awaiting preparing

search
string tùy chọn
bitcoin

Khớp văn bản tự do theo tên hoặc ký hiệu. Không được vượt quá 100 ký tự.

min_price
number tùy chọn
0.5

Chỉ những coin có giá bằng hoặc cao hơn giá trị USD này. Phải ít nhất là 0.

max_price
number tùy chọn
100000

Chỉ những coin có giá bằng hoặc thấp hơn giá trị USD này. Phải ít nhất là 0.

min_marketcap
number tùy chọn
1000000

Chỉ những coin có vốn hóa USD bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_marketcap
number tùy chọn
5000000000000

Chỉ những coin có vốn hóa USD bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những coin có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những coin có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
38,39

Lọc đến các ID coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp với slugs/symbols). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Lọc đến các slug coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp). Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Lọc đến các ký hiệu coin cụ thể (CSV, không phân biệt hoa thường, tối đa 100 bộ chọn kết hợp). Không được vượt quá 1000 ký tự.

sort
string tùy chọn
-marketcap

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: marketcap, rank, price, volume_24h, change_24h, change_7d. Không được vượt quá 100 ký tự.

interval
string tùy chọn
24h

Khoảng biến động chỉ dành cho /coins/gainers và /coins/losers: 24h hoặc 7d.

Một trong: 24h 7d

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoint

Đánh giá ví crypto — score đánh giá, số lượng tài sản được hỗ trợ, số ưu/nhược điểm, mô hình giá và ngày phát hành, cùng phân loại thẻ theo nhóm trong phản hồi chi tiết/so sánh. meta.top_score là điểm cao nhất trong tất cả các ví (dùng nó để chuẩn hóa điểm về khoảng 0–1).

Danh sách ví

Các ví đã được đánh giá cùng điểm số, số lượng tài sản, số ưu/nhược điểm, mô hình giá, trạng thái và ngày phát hành. Phân trang với envelope links + meta của Laravel, cùng meta.top_score.

GET
http://localhost/api/v1/wallets
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

search
string tùy chọn
ledger

Khớp văn bản tự do theo tên ví. Không được vượt quá 100 ký tự.

min_score
integer tùy chọn
50

Chỉ những ví có điểm đánh giá bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_score
integer tùy chọn
214

Chỉ những ví có điểm đánh giá bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

tags
string tùy chọn
12,34

Lọc theo phân loại thẻ: ID nhóm danh mục phân tách bằng dấu phẩy (cùng các ID mà bộ lọc facet trên web gửi lên). Không được vượt quá 1000 ký tự.

ids
string tùy chọn
175,317

Lọc đến các ID ví cụ thể (CSV, tối đa 100). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
frostsnap,coin98-fusion-card

Lọc đến các slug ví cụ thể (CSV, tối đa 100). Không được vượt quá 2000 ký tự.

sort
string tùy chọn
-score

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: score, released_at, assets, pros, cons. Không được vượt quá 100 ký tự.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/wallets?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Dòng thời gian phát hành ví

Danh sách ví ghim theo released_at giảm dần (các ví không có ngày xếp cuối). Cùng cấu trúc dòng và envelope phân trang như List wallets.

GET
http://localhost/api/v1/wallets/timeline
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

search
string tùy chọn
ledger

Khớp văn bản tự do theo tên ví. Không được vượt quá 100 ký tự.

min_score
integer tùy chọn
50

Chỉ những ví có điểm đánh giá bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_score
integer tùy chọn
214

Chỉ những ví có điểm đánh giá bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

tags
string tùy chọn
12,34

Lọc theo phân loại thẻ: ID nhóm danh mục phân tách bằng dấu phẩy (cùng các ID mà bộ lọc facet trên web gửi lên). Không được vượt quá 1000 ký tự.

ids
string tùy chọn
175,317

Lọc đến các ID ví cụ thể (CSV, tối đa 100). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
frostsnap,coin98-fusion-card

Lọc đến các slug ví cụ thể (CSV, tối đa 100). Không được vượt quá 2000 ký tự.

sort
string tùy chọn
-score

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: score, released_at, assets, pros, cons. Không được vượt quá 100 ký tự.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/wallets/timeline?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

So sánh ví

So sánh song song 2–4 ví cùng phân loại thẻ theo nhóm đầy đủ của chúng. data[] giữ nguyên thứ tự slug được yêu cầu để bên tiêu thụ có thể hiển thị các cột theo vị trí.

GET
http://localhost/api/v1/wallets/compare
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

slugs
string bắt buộc
frostsnap,coin98-fusion-card

2–4 slug ví khác nhau, phân tách bằng dấu phẩy.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/wallets/compare?slugs=frostsnap%2Ccoin98-fusion-card" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy chi tiết ví

Hồ sơ đầy đủ của một ví bao gồm phân loại thẻ theo nhóm: categories là một danh sách {group, tags[]} trong đó mỗi thẻ có một slug, tên và giá trị tùy chọn. meta.top_score là điểm cao nhất trong tất cả các ví.

GET
http://localhost/api/v1/wallets/{slug}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
frostsnap

Slug của ví.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Coin được ví hỗ trợ

Các coin mà ví hỗ trợ, trả về cùng cấu trúc như List coins và chấp nhận cùng bộ lọc/sắp xếp.

GET
http://localhost/api/v1/wallets/{slug}/assets
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
frostsnap

Slug của ví.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

type
string tùy chọn
coin

Giới hạn ở một loại tài sản duy nhất: coin hoặc token.

Một trong: coin token

status
string tùy chọn
active

Trạng thái niêm yết: active, delisted, untracked, progressing, awaiting hoặc preparing. Mặc định là tất cả trạng thái công khai.

Một trong: active delisted untracked progressing awaiting preparing

search
string tùy chọn
bitcoin

Khớp văn bản tự do theo tên hoặc ký hiệu. Không được vượt quá 100 ký tự.

min_price
number tùy chọn
0.5

Chỉ những coin có giá bằng hoặc cao hơn giá trị USD này. Phải ít nhất là 0.

max_price
number tùy chọn
100000

Chỉ những coin có giá bằng hoặc thấp hơn giá trị USD này. Phải ít nhất là 0.

min_marketcap
number tùy chọn
1000000

Chỉ những coin có vốn hóa USD bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_marketcap
number tùy chọn
5000000000000

Chỉ những coin có vốn hóa USD bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

min_volume
number tùy chọn
1000000

Chỉ những coin có khối lượng USD 24h bằng hoặc cao hơn giá trị này. Phải ít nhất là 0.

max_volume
number tùy chọn
100000000000

Chỉ những coin có khối lượng USD 24h bằng hoặc thấp hơn giá trị này. Phải ít nhất là 0.

ids
string tùy chọn
38,39

Lọc đến các ID coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp với slugs/symbols). Không được vượt quá 1000 ký tự.

slugs
string tùy chọn
bitcoin,ethereum

Lọc đến các slug coin cụ thể (CSV, tối đa 100 bộ chọn kết hợp). Không được vượt quá 2000 ký tự.

symbols
string tùy chọn
BTC,ETH

Lọc đến các ký hiệu coin cụ thể (CSV, không phân biệt hoa thường, tối đa 100 bộ chọn kết hợp). Không được vượt quá 1000 ký tự.

sort
string tùy chọn
-marketcap

Các trường sắp xếp phân tách bằng dấu phẩy; thêm tiền tố - để giảm dần. Có thể sắp xếp: marketcap, rank, price, volume_24h, change_24h, change_7d. Không được vượt quá 100 ký tự.

interval
string tùy chọn
24h

Khoảng biến động chỉ dành cho /coins/gainers và /coins/losers: 24h hoặc 7d.

Một trong: 24h 7d

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoint

Thị trường toàn cầu

Số liệu tổng hợp toàn thị trường — tổng vốn hóa và khối lượng, số lượng tài sản/sàn/cặp/thị trường, ưu thế BTC/ETH với top-3 theo xếp hạng, số đọc Sợ hãi & Tham lam của thị trường, cùng heatmap top-100 và lịch sử vốn hóa/khối lượng.

Ảnh chụp thị trường toàn cầu

Tổng quan thị trường một lần: tổng vốn hóa và khối lượng 24h, số lượng tiền mã hóa / token / sàn / cặp / thị trường, dominance (tỷ trọng BTC & ETH cùng top3 theo xếp hạng), và số đọc fear_greed của thị trường.

GET
http://localhost/api/v1/global
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/global" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Heatmap thị trường

Các dòng treemap top-100 cùng số liệu khung (tổng vốn hóa/khối lượng, ưu thế và điểm Sợ hãi & Tham lam của thị trường) — bản sao API của heatmap trên web.

GET
http://localhost/api/v1/global/heatmap
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/global/heatmap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lịch sử vốn hóa / khối lượng toàn cầu

Chuỗi thời gian toàn thị trường cho marketcap hoặc volume. Độ chi tiết tùy theo period: 24h = nửa giờ một, 7d = mỗi giờ, 30d/all = hàng ngày (các số liệu gộp mịn hơn bị cắt bớt).

GET
http://localhost/api/v1/global/history/{metric}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

metric
string bắt buộc
marketcap

Chuỗi nào: marketcap hoặc volume.

Tham số truy vấn

period
string tùy chọn
7d

24h, 7d, 30d hoặc all (mặc định 24h).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/global/history/marketcap?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 endpoint

Tâm lý thị trường

Các chỉ số tâm lý toàn thị trường và theo từng coin. Sợ hãi & Tham lam và Bull/Bear là những ẢNH CHỤP làm mới 15 phút — chỉ tồn tại số đọc hiện tại, không có chuỗi thời gian cho chúng. Altseason mang đầy đủ lịch sử hàng ngày. indicators là bảng tổng hợp kỹ thuật toàn thị trường.

Thống kê phiếu bầu cộng đồng

Thống kê cộng đồng tăng giá/giảm giá của coin trong khung 24h trượt.

GET
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Bỏ phiếu tâm lý

Ghi nhận phiếu tâm lý của chủ sở hữu key cho một coin. Một phiếu cho mỗi chủ key cho mỗi coin trong mỗi khung 24h trượt — bỏ phiếu lại trong khung sẽ cập nhật phiếu hiện có.

POST
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

Tham số body

vote
string bắt buộc
bullish

Tâm lý của bạn: bullish hoặc bearish.

Request

curl --request POST \
    "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vote\": \"bullish\"
}"

Chỉ số Sợ hãi & Tham lam

Số đọc Sợ hãi & Tham lam hiện tại (ảnh chụp 15 phút — không có lịch sử). Bỏ trống coin để lấy chỉ số toàn thị trường, hoặc truyền một slug coin để đọc theo từng coin. intervals mang các điểm phụ 7d/30d và bảng phân tích thành phần của chúng.

GET
http://localhost/api/v1/sentiment/fear-greed
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

coin
string tùy chọn
bitcoin

Slug coin để đọc theo từng coin; bỏ trống để lấy chỉ số toàn thị trường.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/sentiment/fear-greed?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Chỉ số Bull / Bear

Số đọc Bull/Bear hiện tại (ảnh chụp 15 phút — không có lịch sử). Bỏ trống coin để lấy chỉ số toàn thị trường, hoặc truyền một slug coin để đọc theo từng coin.

GET
http://localhost/api/v1/sentiment/bull-bear
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

coin
string tùy chọn
bitcoin

Slug coin để đọc theo từng coin; bỏ trống để lấy chỉ số toàn thị trường.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/sentiment/bull-bear?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Chỉ số altseason

Số đọc altseason hiện tại (số coin vượt BTC trong top 100), cùng history hàng ngày tùy chọn. Không như Sợ hãi & Tham lam, altseason có đầy đủ lịch sử hàng ngày — truyền days để bao gồm nó.

GET
http://localhost/api/v1/sentiment/altseason
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

days
integer tùy chọn
30

Số ngày lịch sử hàng ngày cần bao gồm (1–365; 0/bỏ trống = chỉ hiện tại).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/sentiment/altseason?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Bảng tổng hợp chỉ báo thị trường

Bảng tổng hợp kỹ thuật toàn thị trường — 25 danh mục chỉ báo được gộp lại, mỗi danh mục cùng trạng thái hiện tại, điểm số và dữ liệu danh mục của nó.

GET
http://localhost/api/v1/sentiment/indicators
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/sentiment/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
2 endpoint

Chỉ báo

Chỉ báo kỹ thuật theo từng coin — một ảnh chụp đa chỉ báo cùng chuỗi thời gian hàng ngày theo từng nhóm. Tất cả các nhóm đều là chuỗi HÀNG NGÀY được tính từ nến hàng ngày (lưu giữ đầy đủ; các tài sản còn non trả về các giá trị null khởi động cho đến khi có đủ lịch sử). Các nhóm theo thang giá (sma, vwap, macd, obv) phát ra chuỗi thập phân; các bộ dao động có biên phát ra số. Một số kỳ cửa sổ dài yêu cầu gói trả phí (xem endpoint của nhóm).

Ảnh chụp chỉ báo

Ảnh chụp đa chỉ báo — state mới nhất của mỗi danh mục chỉ báo (bullish/bearish/sheepish…), scoredata thô, trong một payload.

GET
http://localhost/api/v1/coins/{slug}/indicators
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Chuỗi nhóm chỉ báo

Chuỗi thời gian hàng ngày của một nhóm chỉ báo. Các nhóm có nhiều cửa sổ chấp nhận một period, và các cửa sổ hợp lệ khác nhau theo từng nhóm: RSI/Stoch-RSI 7/14/21/28, SMA 50/100/200, CCI 20/50/100, MFI 7/14/28, Williams %R 14/20/50, price/volume-volatility 7/14/30. Các nhóm chuỗi đơn (MACD, OBV, ADX, VWAP, CMF) bỏ qua period. Các coin còn non trả về các giá trị null khởi động ở đầu chuỗi.

Một số cửa sổ dài yêu cầu gói trả phí: RSI & Stoch-RSI 21/28 ngày và các cửa sổ biến động 30 ngày cần Starter trở lên — yêu cầu chúng trên gói Free trả về 403 với code plan_required.

GET
http://localhost/api/v1/coins/{slug}/indicators/{family}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Slug của coin.

family
string bắt buộc
rsi

Nhóm chỉ báo — một trong rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf.

Tham số truy vấn

period
integer tùy chọn
14

Độ dài cửa sổ (chỉ khi nhóm có các cửa sổ; phải là một trong các cửa sổ hợp lệ của nhóm đó).

start
string tùy chọn
2026-06-01

Giới hạn dưới ngày dạng ISO.

end
string tùy chọn
2026-06-30

Giới hạn trên ngày dạng ISO.

limit
integer tùy chọn
30

Số dòng tối đa (1–1000, mặc định 365).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators/rsi?period=14&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 endpoint

Thanh lý

Thanh lý phái sinh. Phạm vi nguồn hiện tại chỉ là thị trường swap của OKX (được nêu trong mọi meta.note). Nguồn cấp THÔ (danh sách /liquidations và bảng phân tích theo giờ) bị cắt bớt sau ~48 giờ; số liệu gộp hàng ngày được giữ vĩnh viễn. Số liệu tổng hợp của hôm nay là một phần và cập nhật mỗi ~15 phút.

Nguồn cấp thanh lý

Nguồn cấp thanh lý thô (~48h gần nhất, sau đó bị cắt bớt), mới nhất trước. Phạm vi nguồn hiện tại là thị trường swap của OKX. Giá là chuỗi thập phân. meta mang các trường phân trang cùng một retentionnote.

GET
http://localhost/api/v1/liquidations
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1). Phải ít nhất là 1.

per_page
integer tùy chọn
50

Số dòng mỗi trang. Giới hạn tùy theo gói (Free 100, Starter/Pro 250); vượt quá sẽ trả về 422 thay vì cắt bớt. Phải ít nhất là 1. Không được vượt quá 100.

exchange
string tùy chọn
okx

Giới hạn ở một sàn giao dịch duy nhất theo slug. Phạm vi nguồn hiện tại là thị trường swap của OKX. Phải khớp regex /^[a-z0-9-]{1,120}$/.

instrument
string tùy chọn
swap

Loại công cụ: future, option, swap, spot hoặc margin.

Một trong: future option swap spot margin

position
string tùy chọn
short

Phía vị thế bị thanh lý: long hoặc short.

Một trong: long short

order
string tùy chọn
buy

Phía khớp lệnh đã kích hoạt thanh lý: buy hoặc sell.

Một trong: buy sell

symbol
string tùy chọn
BTC

Khớp tiền tố theo instId của nơi giao dịch (ví dụ BTC khớp BTC-USDT-SWAP). Phải khớp regex /^[A-Za-z0-9$.-]{1,25}$/.

min_usd
number tùy chọn
1000

Chỉ những lần thanh lý có giá trị USD bằng hoặc cao hơn ngưỡng này. Phải ít nhất là 0.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/liquidations?page=1&per_page=50&exchange=okx&instrument=swap&position=short&order=buy&symbol=BTC&min_usd=1000" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Thanh lý theo giờ

Tổng USD long/short theo giờ trên nguồn cấp thô. Vì nguồn cấp thô bị cắt bớt sau ~48h, hours được giới hạn ở 48. Phạm vi nguồn hiện tại là thị trường swap của OKX.

GET
http://localhost/api/v1/liquidations/hourly
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

hours
integer tùy chọn
24

Khoảng nhìn lại tính theo giờ (1–48, mặc định 24).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/liquidations/hourly?hours=24" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Thanh lý hàng ngày

Số liệu tổng hợp hàng ngày (giữ vĩnh viễn), cộng dồn trên các sàn/công cụ theo từng ngày — tổng/long/short USD cùng số lượng vị thế long/short. Dòng của hôm nay là một phần và cập nhật mỗi ~15 phút. Phạm vi nguồn hiện tại là thị trường swap của OKX.

GET
http://localhost/api/v1/liquidations/daily
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

days
integer tùy chọn
30

Số ngày theo lịch tính cả hôm nay (1–365, mặc định 30).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/liquidations/daily?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tóm tắt thanh lý hôm nay

Từ đầu hôm nay đến giờ — tổng/long/short USD, số lượng vị thế và dominance long so với short. Các con số là một phần và cập nhật mỗi ~15 phút; data là null cho đến khi lần thanh lý đầu tiên trong ngày được ghi nhận. Phạm vi nguồn hiện tại là thị trường swap của OKX.

GET
http://localhost/api/v1/liquidations/summary
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/liquidations/summary" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Dòng ròng thanh lý

Dòng USD thanh lý long so với short theo từng ngày trong khoảng. Phạm vi nguồn hiện tại là thị trường swap của OKX.

GET
http://localhost/api/v1/liquidations/netflow
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

days
integer tùy chọn
30

Số ngày theo lịch tính cả hôm nay (1–90, mặc định 30).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/liquidations/netflow?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Các coin bị thanh lý nhiều nhất

Các coin hàng đầu theo khối lượng thanh lý trong khoảng gần đây, cùng phân tách USD long/short theo từng coin. Phạm vi nguồn hiện tại là thị trường swap của OKX.

GET
http://localhost/api/v1/liquidations/coins
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

hours
integer tùy chọn
24

Khoảng nhìn lại tính theo giờ (1–48, mặc định 24).

limit
integer tùy chọn
8

Số coin cần trả về (1–20, mặc định 8).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/liquidations/coins?hours=24&limit=8" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoint

Chuyển đổi

Chuyển đổi giữa hai tài sản đang hoạt động bất kỳ (cả crypto VÀ fiat), và liệt kê các loại tiền tệ có thể dùng làm vế chuyển đổi. Giá trị là chuỗi thập phân. Tỷ giá fiat làm mới ~hai lần mỗi ngày; tỷ giá crypto ~mỗi phút.

Chuyển đổi giữa các tài sản

Chuyển đổi phía máy chủ giữa hai tài sản đang hoạt động bất kỳ (cả crypto VÀ fiat). to chấp nhận một CSV để chuyển đổi nhiều đích; đảo chiều chỉ là hoán đổi from/to. Chuyển đổi là tuyến tính, nên value = unit_rate * amount. Tỷ giá fiat làm mới ~hai lần mỗi ngày; tỷ giá crypto ~mỗi phút.

GET
http://localhost/api/v1/convert
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

from
string bắt buộc
bitcoin

Slug tài sản nguồn.

to
string bắt buộc
ethereum

Slug tài sản đích, phân tách bằng dấu phẩy (tối đa 10).

amount
number tùy chọn
2.5

Lượng tài sản nguồn cần chuyển đổi (mặc định 1).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/convert?from=bitcoin&to=ethereum&amount=2.5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Danh sách tiền tệ fiat

Các loại tiền tệ fiat đang hoạt động cùng tỷ giá USD của chúng: rate_per_usd (số đơn vị trên một USD) và nghịch đảo của nó usd_value. Tỷ giá fiat làm mới ~hai lần mỗi ngày.

GET
http://localhost/api/v1/fiats
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/fiats" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Danh sách tỷ giá chuyển đổi

Các loại tiền đối chiếu có thể dùng làm vế chuyển đổi — các fiat, coin và token hàng đầu — mỗi loại cùng một usd_value đã chuẩn hóa (USD trên một đơn vị). Giá trị coin/token làm mới ~mỗi phút; các tỷ giá fiat chậm được cache riêng (~hai lần mỗi ngày).

GET
http://localhost/api/v1/rates
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/rates" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoint

Công cụ tính toán

Các công cụ tính tài chính phía máy chủ phản chiếu các công cụ trên web: DCA, lãi/lỗ và khoản vay (đọc dữ liệu thị trường đã cache), cùng các phép tính lãi kép và staking không trạng thái.

Công cụ tính DCA

Backtest trung bình giá (DCA) trên lịch sử giá hàng ngày thực của coin: một lần mua amount mỗi interval giữa startend. Truyền series=true để bao gồm toàn bộ chuỗi theo từng lần mua.

GET
http://localhost/api/v1/calculators/dca
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

amount
number bắt buộc
100

USD chi cho mỗi lần mua (0.01–1,000,000,000).

interval
string bắt buộc
weekly

Tần suất mua: daily, weekly, monthly, quarterly hoặc yearly.

start
string bắt buộc
2024-01-01

date Ngày mua đầu tiên (sau 2008-12-31).

end
string tùy chọn
2025-01-01

date Ngày mua cuối cùng (mặc định là hôm nay).

series
boolean tùy chọn
false

Bao gồm chuỗi theo từng lần mua trong payload.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/calculators/dca?slug=bitcoin&amount=100&interval=weekly&start=2024-01-01&end=2025-01-01&series=" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Công cụ tính lãi / lỗ

Kết quả của việc mua rồi bán giữa hai ngày lịch sử, dùng giá thực của coin vào những ngày đó. Phí là các khoản USD cố định, không phải phần trăm.

GET
http://localhost/api/v1/calculators/profit-loss
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

amount
number bắt buộc
1000

USD đã đầu tư vào buy_date (0.01–1,000,000,000).

buy_date
string bắt buộc
2023-01-01

date Ngày mua.

sell_date
string bắt buộc
2025-01-01

date Ngày bán (vào/sau buy_date).

buy_fee
number tùy chọn
10

Phí mua cố định tính bằng USD (mặc định 0).

sell_fee
number tùy chọn
10

Phí bán cố định tính bằng USD (mặc định 0).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/calculators/profit-loss?slug=bitcoin&amount=1000&buy_date=2023-01-01&sell_date=2025-01-01&buy_fee=10&sell_fee=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Công cụ tính lãi kép

Toán học thuần túy — không có dữ liệu thị trường. Lưu ý rằng lãi suất áp dụng CHO MỖI KỲ GHÉP LÃI (theo quy ước của công cụ tính trên web), không phải theo năm.

GET
http://localhost/api/v1/calculators/compound-interest
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

principal
number bắt buộc
10000

Số dư khởi đầu tính bằng USD.

rate
number bắt buộc
1

Lãi suất tính theo % cho mỗi kỳ ghép lãi.

duration
integer bắt buộc
5

Độ dài của dự phóng (số năm giới hạn ở 50).

duration_unit
string tùy chọn
years

years (mặc định) hoặc months.

compound_frequency
string tùy chọn
monthly

daily, weekly, monthly (mặc định), quarterly hoặc annually.

contribution
number tùy chọn
100

Khoản nạp định kỳ tính bằng USD (mặc định 0).

contribution_frequency
string tùy chọn
monthly

daily, weekly, monthly (mặc định), quarterly hoặc annually.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/calculators/compound-interest?principal=10000&rate=1&duration=5&duration_unit=years&compound_frequency=monthly&contribution=100&contribution_frequency=monthly" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Công cụ tính vay so với bán

Vay thế chấp bằng crypto so với bán nó — so sánh cả hai kịch bản dùng giá HIỆN TẠI của coin. Dự phóng mang tính thông tin, không phải lời khuyên tài chính.

GET
http://localhost/api/v1/calculators/loan
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

crypto_amount
number bắt buộc
2

Số lượng coin bạn đang nắm giữ.

needed_cash
number bắt buộc
50000

Số USD bạn cần giải phóng.

term_months
integer tùy chọn
36

Kỳ hạn khoản vay tính theo tháng (mặc định 36).

interest_rate
number tùy chọn
10

APR khoản vay tính theo % (mặc định 10).

ltv
number tùy chọn
50

Tỷ lệ khoản vay trên giá trị (LTV) tính theo % (mặc định 50).

expected_growth
number tùy chọn
25

Mức tăng giá coin kỳ vọng trong kỳ hạn tính theo % (mặc định 25).

tax_rate
number tùy chọn
25

Thuế lãi vốn tính theo % áp dụng cho lần bán (mặc định 25).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/calculators/loan?slug=bitcoin&crypto_amount=2&needed_cash=50000&term_months=36&interest_rate=10&ltv=50&expected_growth=25&tax_rate=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Công cụ tính phần thưởng staking

Toán học thuần túy — phần thưởng staking với ghép lãi tùy chọn và hoa hồng validator. Không đọc dữ liệu thị trường.

GET
http://localhost/api/v1/calculators/staking
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

amount
number bắt buộc
1000

Lượng đã stake, theo đơn vị của tài sản được stake.

period
number bắt buộc
2

Độ dài của kỳ staking (giới hạn tương đương 50 năm).

period_unit
string tùy chọn
years

years (mặc định), months hoặc days.

apy
number bắt buộc
5

APY công bố tính theo %.

compound_frequency
string tùy chọn
monthly

never, daily, weekly, monthly (mặc định) hoặc yearly.

commission
number tùy chọn
10

Hoa hồng validator tính theo %, lấy từ phần thưởng (mặc định 0).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/calculators/staking?amount=1000&period=2&period_unit=years&apy=5&compound_frequency=monthly&commission=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
8 endpoint

Nội dung biên tập

Bài viết biên tập — chỉ những bài đã xuất bản (ACTIVE). locale chọn ngôn ngữ nội dung với dự phòng tiếng Anh theo từng trường (payload báo cáo locale nào thực sự được chọn). Bài viết có thể được lọc theo thẻ hoặc theo slug coin/exchange/wallet liên quan. Các lần đọc qua API cố ý KHÔNG tăng số lượt xem.

Video của coin

Video được tuyển chọn gắn với một coin (tab Videos của trang coin), có phân trang.

GET
http://localhost/api/v1/coins/{slug}/videos
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1).

per_page
integer tùy chọn
10

Số dòng mỗi trang (1–50, mặc định 10).

type
string tùy chọn
review

Lọc theo loại video (ví dụ overview, tutorial, explainer, review, analysis, news).

search
string tùy chọn
halving

Khớp văn bản tự do theo tiêu đề.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/videos?page=1&per_page=10&type=review&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Dòng thời gian nhận định coin

Dòng thời gian nhận định của coin — cùng payload mà bảng nhận định trên trang tài sản sử dụng, giới hạn cửa sổ theo offset/limit.

GET
http://localhost/api/v1/coins/{slug}/insights
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
bitcoin

Định danh slug của coin.

Tham số truy vấn

locale
string tùy chọn
en

Ngôn ngữ nội dung (dự phòng về tiếng Anh).

offset
integer tùy chọn
0

Số dòng cần bỏ qua (0–500, mặc định 0).

limit
integer tùy chọn
5

Số dòng cần trả về (1–50, mặc định 5).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/insights?locale=en&offset=0&limit=5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Danh sách bài viết

Các bài viết đã xuất bản, mới nhất trước, có phân trang. Lọc theo tag hoặc theo slug coin / exchange / wallet liên quan, hoặc search văn bản tự do. Mỗi dòng là một bản tóm tắt (tiêu đề, tiêu đề phụ, thẻ, thời gian đọc, ảnh bìa, các thực thể liên quan, ngày tháng).

GET
http://localhost/api/v1/articles
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1).

per_page
integer tùy chọn
20

Số dòng mỗi trang (1–50, mặc định 20).

locale
string tùy chọn
en

Ngôn ngữ nội dung (dự phòng về tiếng Anh).

tag
string tùy chọn
guide

Lọc theo thẻ: news, guide, tutorial, explainer, analysis, review, trading, overview hoặc information.

coin
string tùy chọn
bitcoin

Lọc đến các bài viết liên quan đến slug coin này.

exchange
string tùy chọn
binance-exchange

Lọc đến các bài viết liên quan đến slug sàn giao dịch này.

wallet
string tùy chọn
frostsnap

Lọc đến các bài viết liên quan đến slug ví này.

search
string tùy chọn
halving

Khớp văn bản tự do theo tiêu đề/tiêu đề phụ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/articles?page=1&per_page=20&locale=en&tag=guide&coin=bitcoin&exchange=binance-exchange&wallet=frostsnap&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy một bài viết

Một bài viết đã xuất bản cùng toàn bộ nội dung, thẻ, ảnh bìa, bộ đếm hữu ích và các thực thể liên quan. locale chọn ngôn ngữ nội dung với dự phòng tiếng Anh theo từng trường (payload báo cáo locale nào thực sự được chọn).

GET
http://localhost/api/v1/articles/{slug}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
what-is-bitcoin

Slug của bài viết.

Tham số truy vấn

locale
string tùy chọn
en

Ngôn ngữ nội dung (dự phòng về tiếng Anh).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/articles/what-is-bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Gửi phản hồi bài viết

Ghi nhận một lượt thích/không thích trên một bài viết — cùng các bộ đếm mà nút hữu ích trên web sử dụng. Giới hạn tần suất theo từng key được áp dụng ở phía trên.

POST
http://localhost/api/v1/articles/{slug}/feedback
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

slug
string bắt buộc
what-is-bitcoin

Slug của bài viết.

Tham số body

helpful
boolean bắt buộc
true

true cho hữu ích, false cho không hữu ích.

Request

curl --request POST \
    "http://localhost/api/v1/articles/what-is-bitcoin/feedback" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"helpful\": true
}"

Lấy một video

Một video được tuyển chọn cùng YouTube id, tiêu đề, loại, thời lượng và các coin/sàn/ví mà nó được gắn kèm.

GET
http://localhost/api/v1/videos/{id}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
87

ID của video.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/videos/87" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Danh sách nhận định

Nhận định thị trường do AI tạo, có phân trang. Lọc theo type, một slug coin liên quan hoặc search văn bản tự do; locale chọn ngôn ngữ tiêu đề/tóm tắt với dự phòng tiếng Anh.

GET
http://localhost/api/v1/insights
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1).

per_page
integer tùy chọn
20

Số dòng mỗi trang (1–50, mặc định 20).

locale
string tùy chọn
en

Ngôn ngữ nội dung (dự phòng về tiếng Anh).

type
string tùy chọn
per_asset

Lọc theo loại nhận định: per_asset, market_overview hoặc narrative.

coin
string tùy chọn
bitcoin

Lọc đến các nhận định về slug coin này.

search
string tùy chọn
etf

Khớp văn bản tự do theo tiêu đề.

sort
string tùy chọn
first_reported

Thứ tự sắp xếp: first_reported (mặc định) hoặc last_updated.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/insights?page=1&per_page=20&locale=en&type=per_asset&coin=bitcoin&search=etf&sort=first_reported" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lấy một nhận định

Một nhận định cùng payload đầy đủ của nó — tiêu đề, tóm tắt, dòng thời gian bài viết nguồn và các coin liên quan.

GET
http://localhost/api/v1/insights/{id}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
101

ID của nhận định.

Tham số truy vấn

locale
string tùy chọn
en

Ngôn ngữ nội dung (dự phòng về tiếng Anh).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/insights/101?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoint

Báo động

CRUD báo động giá — cùng những báo động mà ứng dụng web quản lý. Báo động tiêu tốn số dư tồn kho báo động của chủ sở hữu key, chỉ thuộc loại TARGET trên các coin, và một cơ chế bảo vệ above/below so với giá trị hiện tại chặn các báo động có thể tự kích hoạt ngay lập tức. Được giới hạn theo key (API key xác định chủ sở hữu) và không bao giờ cache phản hồi.

Danh sách báo động

Các báo động của chủ sở hữu key, mới nhất trước, có phân trang. Lọc theo status, direction hoặc kênh notification.

GET
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1).

per_page
integer tùy chọn
25

Số dòng mỗi trang (1–100, mặc định 25).

status
string tùy chọn
active

Lọc theo trạng thái: active hoặc triggered.

direction
string tùy chọn
above

Lọc theo hướng kích hoạt: above hoặc below.

notification
string tùy chọn
email

Lọc theo kênh gửi: email, push hoặc webhook.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/alarms?page=1&per_page=25&status=active&direction=above&notification=email" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tạo một báo động

Tạo một báo động loại TARGET trên một coin và tiêu tốn một suất báo động từ số dư của chủ sở hữu key. Mục tiêu được kiểm tra so với giá trị hiện tại của coin nên báo động không thể tự kích hoạt ngay lập tức: báo động above phải đặt mục tiêu lớn hơn giá trị hiện tại, báo động below thì nhỏ hơn.

POST
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số body

name
string bắt buộc
BTC six figures

Nhãn cho báo động (tối đa 255 ký tự).

coin
string bắt buộc
bitcoin

Định danh slug của coin.

metric
string bắt buộc
rate

Chỉ số được theo dõi: rate, volume hoặc marketcap.

direction
string bắt buộc
above

Hướng kích hoạt: above hoặc below.

target
number bắt buộc
100000

Giá trị ngưỡng (phải nằm ở phía direction so với giá trị hiện tại của coin).

notification
string bắt buộc
email

Kênh gửi: email, push hoặc webhook.

Request

curl --request POST \
    "http://localhost/api/v1/alarms" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"BTC six figures\",
    \"coin\": \"bitcoin\",
    \"metric\": \"rate\",
    \"direction\": \"above\",
    \"target\": 100000,
    \"notification\": \"email\"
}"

Xóa một báo động

Xóa một trong các báo động của chủ sở hữu key và hoàn lại suất báo động mà nó đã dùng.

DELETE
http://localhost/api/v1/alarms/{id}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
42

ID của báo động.

Request

curl --request DELETE \
    "http://localhost/api/v1/alarms/42" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoint

Webhooks

Bitculator gửi POST mỗi sự kiện dưới dạng JSON kèm một header chữ ký HMAC:

X-Bitculator-Signature: t=<unix-ts>,v1=<hex hmac_sha256("<ts>.<raw-body>", secret)>
X-Bitculator-Event: alarm.triggered

Xác minh bằng cách tính lại HMAC trên "." với secret của endpoint của bạn và so sánh trong thời gian hằng số; từ chối nếu t cũ hơn vài phút (bảo vệ chống replay). Ví dụ (PHP):

[$t, $v1] = sscanf($_SERVER['HTTP_X_BITCULATOR_SIGNATURE'], 't=%d,v1=%s');
$expected = hash_hmac('sha256', $t.'.'.file_get_contents('php://input'), $secret);
abort_unless(hash_equals($expected, $v1) && abs(time() - $t) < 300, 403);

Các sự kiện được hỗ trợ: alarm.triggered. Các lần gửi thử lại 3× với backoff; một endpoint tự vô hiệu hóa sau 10 lần gửi thất bại liên tiếp.

Danh sách webhook endpoint

Các webhook endpoint của chủ sở hữu key, mới nhất trước. Các secret để ký không bao giờ được bao gồm — mỗi secret chỉ được hiển thị đúng một lần, khi tạo.

GET
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tạo một webhook endpoint

Đăng ký một endpoint HTTPS (tối đa 5 cho mỗi tài khoản) để nhận các sự kiện. Phản hồi bao gồm secret để ký — LẦN DUY NHẤT nó được hiển thị, nên hãy lưu lại ngay lập tức.

POST
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số body

url
string bắt buộc
https://example.com/webhooks/bitculator

URL gửi qua HTTPS. Chỉ chấp nhận host công khai — các địa chỉ nội bộ/riêng tư sẽ bị từ chối.

events
string[] bắt buộc
["alarm.triggered"]

Các sự kiện cần đăng ký. Giá trị cho phép: alarm.triggered.

Request

curl --request POST \
    "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/example.com\\/webhooks\\/bitculator\",
    \"events\": [
        \"alarm.triggered\"
    ]
}"

Xóa một webhook endpoint

Xóa một trong các webhook endpoint của chủ sở hữu key. Các lần gửi đang chờ đến nó sẽ bị hủy bỏ.

DELETE
http://localhost/api/v1/webhooks/{id}
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
7

ID của webhook endpoint.

Request

curl --request DELETE \
    "http://localhost/api/v1/webhooks/7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Gửi một sự kiện thử nghiệm

Kích hoạt một sự kiện thử nghiệm alarm.triggered đã ký (test: true trong payload, header chữ ký thật) để bên nhận có thể được kiểm tra từ đầu đến cuối.

POST
http://localhost/api/v1/webhooks/{id}/test
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
7

ID của webhook endpoint.

Request

curl --request POST \
    "http://localhost/api/v1/webhooks/7/test" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Nhật ký gửi webhook

Các lần gửi của endpoint (giữ 30 ngày), mới nhất trước, có phân trang.

GET
http://localhost/api/v1/webhooks/{id}/deliveries
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Tham số đường dẫn

id
integer bắt buộc
7

ID của webhook endpoint.

Tham số truy vấn

page
integer tùy chọn
1

Số trang (bắt đầu từ 1).

per_page
integer tùy chọn
25

Số dòng mỗi trang (1–100, mặc định 25).

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/webhooks/7/deliveries?page=1&per_page=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoint

Meta

Meta và nội quan API: một ping đã xác thực để kiểm tra một key và ngăn xếp middleware, mức sử dụng/hạn ngạch của key hiện tại, và đặc tả OpenAPI máy có thể đọc được.

Đặc tả OpenAPI

Tài liệu OpenAPI 3 máy có thể đọc được cho API này, dưới dạng JSON — hãy trỏ công cụ codegen hoặc công cụ API vào URL này. Công khai: không cần key.

GET
http://localhost/api/v1/openapi.json
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/openapi.json" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Ping

Một lệnh không thao tác đã xác thực để kiểm tra Data API key từ đầu đến cuối (auth.api → giới hạn burst theo gói → hạn ngạch hàng tháng). Nó tính vào hạn ngạch như bất kỳ lệnh gọi nào khác.

GET
http://localhost/api/v1/ping
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/ping" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mức sử dụng & hạn ngạch của key

Nội quan mức sử dụng cho chủ sở hữu key gọi: gói Data API, giới hạn hàng tháng của nó, đã dùng và còn lại (luôn khớp với các header X-Quota-*), cửa sổ chu kỳ hiện tại, và bảng phân tích theo từng endpoint / từng token. Mức sử dụng widget embed có gói và quỹ riêng — nó không bao giờ xuất hiện ở đây.

GET
http://localhost/api/v1/usage
Bearer
bc_••••••••••••••••

Key chỉ dùng Bearer và mang quyền data-api — hãy giữ chúng ở phía máy chủ.

Request GET — không có body request.

Request

curl --request GET \
    --get "http://localhost/api/v1/usage" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"