Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 ендпоінтів 15 груп X-Quota-* у кожному виклику http://localhost/api/v1

Усі ендпоінти розміщені під /api/v1 і потребують Bearer-ключа з дозволом data-api — створіть його у консолі розробника.

Ваш перший запит:

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

Відповіді у форматі JSON. Ціни, курси та обсяги пропозиції — це десяткові рядки (числа з рухомою комою не здатні передати ринкову точність); лічильники та аналітичні значення — це числа. Кожна відповідь містить вашу поточну квоту в заголовках X-Quota-Limit / X-Quota-Used / X-Quota-Reset, а помилки завжди використовують оболонку {"error": {"code", "message", "details"}}.

Data API має власну місячну квоту, прив'язану до вашого тарифу API та повністю окрему від ваших embed-віджетів. Ліміти per_page залежать від тарифу (Free 100, Starter/Pro 250); перевищення ліміту повертає 422, а не обрізає значення.

Автентифікація

Щоб автентифікувати запити, додавайте заголовок Authorization: Bearer {YOUR_API_KEY} до кожного запиту.

Створіть ключ Data API у консолі розробника — ключі працюють лише як Bearer і несуть дозвіл data-api. Зберігайте їх на боці сервера; вони не призначені для вбудовування на боці клієнта.

Заголовок авторизації
Створити ключ →
Bearer
bc_••••••••••••••••

Надсилається як Authorization: Bearer {YOUR_API_KEY} у кожному запиті.

9 ендпоінтів

Монети

Ринкові дані монет і токенів за рейтингом: переліки з пагінацією, деталі окремої монети, рухи (gainers/losers), нещодавно додані, трендові та по-монетні часові ряди. Ціни, капіталізація та пропозиція — це десяткові РЯДКИ (числа з рухомою комою не здатні передати ринкову точність); відсоткові зміни, ранги та лічильники — це числа.

Список монет

Монети за рейтингом із цінами, фільтрами та селекторами, з пагінацією через оболонку Laravel links + meta. Ціни, капіталізація та circulating_supply — це десяткові рядки; зміни та ранги — це числа.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
coin

Обмежити одним типом активу: coin або token.

Одне з: coin token

status
string необов'язковий
active

Статус лістингу: active, delisted, untracked, progressing, awaiting або preparing. Типово всі публічні статуси.

Одне з: active delisted untracked progressing awaiting preparing

search
string необов'язковий
bitcoin

Пошук за вільним текстом у назві або символі. Не має перевищувати 100 символів.

min_price
number необов'язковий
0.5

Лише монети з ціною на рівні цього значення в USD або вище. Має бути щонайменше 0.

max_price
number необов'язковий
100000

Лише монети з ціною на рівні цього значення в USD або нижче. Має бути щонайменше 0.

min_marketcap
number необов'язковий
1000000

Лише монети з капіталізацією в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_marketcap
number необов'язковий
5000000000000

Лише монети з капіталізацією в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише монети з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише монети з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
38,39

Фільтр до конкретних ідентифікаторів монет (CSV, до 100 селекторів разом зі slugs/symbols). Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Фільтр до конкретних слагів монет (CSV, до 100 селекторів разом). Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Фільтр до конкретних символів монет (CSV, без урахування регістру, до 100 селекторів разом). Не має перевищувати 1000 символів.

sort
string необов'язковий
-marketcap

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: marketcap, rank, price, volume_24h, change_24h, change_7d. Не має перевищувати 100 символів.

interval
string необов'язковий
24h

Вікно рухів лише для /coins/gainers та /coins/losers: 24h або 7d.

Одне з: 24h 7d

GET-запит — тіло запиту відсутнє.

Запит

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"

Нещодавно додані монети

Найновіші лістинги — відсортовані за status_updated_at (мітка часу переходу в active; created_at — це дата збору даних, яка передує лістингу на довільний час). Той самий формат рядка й оболонка пагінації, що й у List coins.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
coin

Обмежити одним типом активу: coin або token.

Одне з: coin token

status
string необов'язковий
active

Статус лістингу: active, delisted, untracked, progressing, awaiting або preparing. Типово всі публічні статуси.

Одне з: active delisted untracked progressing awaiting preparing

search
string необов'язковий
bitcoin

Пошук за вільним текстом у назві або символі. Не має перевищувати 100 символів.

min_price
number необов'язковий
0.5

Лише монети з ціною на рівні цього значення в USD або вище. Має бути щонайменше 0.

max_price
number необов'язковий
100000

Лише монети з ціною на рівні цього значення в USD або нижче. Має бути щонайменше 0.

min_marketcap
number необов'язковий
1000000

Лише монети з капіталізацією в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_marketcap
number необов'язковий
5000000000000

Лише монети з капіталізацією в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише монети з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише монети з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
38,39

Фільтр до конкретних ідентифікаторів монет (CSV, до 100 селекторів разом зі slugs/symbols). Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Фільтр до конкретних слагів монет (CSV, до 100 селекторів разом). Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Фільтр до конкретних символів монет (CSV, без урахування регістру, до 100 селекторів разом). Не має перевищувати 1000 символів.

sort
string необов'язковий
-marketcap

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: marketcap, rank, price, volume_24h, change_24h, change_7d. Не має перевищувати 100 символів.

interval
string необов'язковий
24h

Вікно рухів лише для /coins/gainers та /coins/losers: 24h або 7d.

Одне з: 24h 7d

GET-запит — тіло запиту відсутнє.

Запит

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"

Лідери зростання

Найбільші додатні рухи за вікно interval (24h типово або 7d). Той самий формат рядка й оболонка пагінації, що й у List coins.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
coin

Обмежити одним типом активу: coin або token.

Одне з: coin token

status
string необов'язковий
active

Статус лістингу: active, delisted, untracked, progressing, awaiting або preparing. Типово всі публічні статуси.

Одне з: active delisted untracked progressing awaiting preparing

search
string необов'язковий
bitcoin

Пошук за вільним текстом у назві або символі. Не має перевищувати 100 символів.

min_price
number необов'язковий
0.5

Лише монети з ціною на рівні цього значення в USD або вище. Має бути щонайменше 0.

max_price
number необов'язковий
100000

Лише монети з ціною на рівні цього значення в USD або нижче. Має бути щонайменше 0.

min_marketcap
number необов'язковий
1000000

Лише монети з капіталізацією в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_marketcap
number необов'язковий
5000000000000

Лише монети з капіталізацією в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише монети з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише монети з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
38,39

Фільтр до конкретних ідентифікаторів монет (CSV, до 100 селекторів разом зі slugs/symbols). Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Фільтр до конкретних слагів монет (CSV, до 100 селекторів разом). Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Фільтр до конкретних символів монет (CSV, без урахування регістру, до 100 селекторів разом). Не має перевищувати 1000 символів.

sort
string необов'язковий
-marketcap

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: marketcap, rank, price, volume_24h, change_24h, change_7d. Не має перевищувати 100 символів.

interval
string необов'язковий
24h

Вікно рухів лише для /coins/gainers та /coins/losers: 24h або 7d.

Одне з: 24h 7d

GET-запит — тіло запиту відсутнє.

Запит

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"

Лідери падіння

Найбільші від'ємні рухи за вікно interval (24h типово або 7d). Той самий формат рядка й оболонка пагінації, що й у List coins.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
coin

Обмежити одним типом активу: coin або token.

Одне з: coin token

status
string необов'язковий
active

Статус лістингу: active, delisted, untracked, progressing, awaiting або preparing. Типово всі публічні статуси.

Одне з: active delisted untracked progressing awaiting preparing

search
string необов'язковий
bitcoin

Пошук за вільним текстом у назві або символі. Не має перевищувати 100 символів.

min_price
number необов'язковий
0.5

Лише монети з ціною на рівні цього значення в USD або вище. Має бути щонайменше 0.

max_price
number необов'язковий
100000

Лише монети з ціною на рівні цього значення в USD або нижче. Має бути щонайменше 0.

min_marketcap
number необов'язковий
1000000

Лише монети з капіталізацією в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_marketcap
number необов'язковий
5000000000000

Лише монети з капіталізацією в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише монети з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише монети з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
38,39

Фільтр до конкретних ідентифікаторів монет (CSV, до 100 селекторів разом зі slugs/symbols). Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Фільтр до конкретних слагів монет (CSV, до 100 селекторів разом). Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Фільтр до конкретних символів монет (CSV, без урахування регістру, до 100 селекторів разом). Не має перевищувати 1000 символів.

sort
string необов'язковий
-marketcap

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: marketcap, rank, price, volume_24h, change_24h, change_7d. Не має перевищувати 100 символів.

interval
string необов'язковий
24h

Вікно рухів лише для /coins/gainers та /coins/losers: 24h або 7d.

Одне з: 24h 7d

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати деталі монети

Повний профіль однієї монети. Окрім полів зі списку, додає: supply (circulating/total/max), today OHLC, all_time_high / all_time_low (ціна, дата та percent_from поточної ціни), fully_diluted_valuation, ринкові counts (exchanges/pairs/tickers/wallets), decimals, genesis_date, офіційні links (типізований список url), contracts токена та локалізований HTML-description (за замовчуванням англійський, коли запитана мова відсутня). Усі поля цін/пропозиції — це десяткові рядки.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

Параметри запиту

locale
string необов'язковий
en

Мова контенту для опису (за замовчуванням англійська).

GET-запит — тіло запиту відсутнє.

Запит

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"

Історія свічок

По-монетний часовий ряд OHLC + обсяг + капіталізація. Оберіть interval: minutely, half-hourly, hourly або daily. Термін зберігання — це жорстка властивість конвеєра агрегації — minutely 8 днів, half-hourly 3 місяці, hourly 6 місяців, daily назавжди; запити поза вікном повертають те, що існує. Коли встановлено limit, ви отримуєте НАЙНОВІШІ N рядків у вікні, видані від найстаріших. Ціни — це десяткові рядки.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

Параметри запиту

interval
string необов'язковий
daily

minutely, half-hourly, hourly або daily (типово daily).

start
string необов'язковий
2026-06-01

Нижня межа дати/часу ISO.

end
string необов'язковий
2026-06-30

Верхня межа дати/часу ISO (значення лише з датою означає включно до цього дня).

limit
integer необов'язковий
30

Максимум рядків (1–2000, типово 1000).

GET-запит — тіло запиту відсутнє.

Запит

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"

Історія капіталізації

Ті самі по-монетні агрегати, що й Candle history, спроєктовані лише на {time, marketcap}. Ті самі варіанти interval та вікна зберігання (minutely 8 днів, half-hourly 3 місяці, hourly 6 місяців, daily назавжди), найновіші N, коли встановлено limit.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

Параметри запиту

interval
string необов'язковий
daily

minutely, half-hourly, hourly або daily (типово daily).

start
string необов'язковий
2026-06-01

Нижня межа дати/часу ISO.

end
string необов'язковий
2026-06-30

Верхня межа дати/часу ISO.

limit
integer необов'язковий
30

Максимум рядків (1–2000, типово 1000).

GET-запит — тіло запиту відсутнє.

Запит

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"

Спарклайн монети

Компактна серія цін монети за вибраний period для побудови спарклайнів.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

Параметри запиту

period
string необов'язковий
7d

24h, 7d, 30d, 60d, 90d, 180d або 365d (типово 7d).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Ціни

Полегшений «гарячий шлях» цін — поточна ціна, капіталізація, обсяг за 24h і нещодавні зміни для запитаного набору монет. /prices потребує селектора (ids, slugs або symbols); /prices/{slug} націлюється на одну монету. За бажанням convert у фіатну валюту (ціни крипто оновлюються ~щохвилини, фіатні курси ~двічі на день). Ціни та капіталізація — це десяткові рядки.

Отримати ціни

Ціни для запитаного набору монет. Передайте щонайменше один селектор — ids, slugs або symbols (до 100 разом). meta.currency відображає цільову валюту конвертації (USD, якщо не встановлено convert).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

ids
string необов'язковий
38,39

Ідентифікатори монет для відображення цін (CSV). Потрібен щонайменше один з ids, slugs або symbols; три списки разом обмежені 100 селекторами. Це поле обов'язкове, коли відсутні slugs та symbols. Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Слаги монет для відображення цін (CSV). Потрібен щонайменше один з ids, slugs або symbols. Це поле обов'язкове, коли відсутні ids та symbols. Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Символи монет для відображення цін (CSV, без урахування регістру). Потрібен щонайменше один з ids, slugs або symbols. Це поле обов'язкове, коли відсутні ids та slugs. Не має перевищувати 1000 символів.

convert
string необов'язковий
EUR

Конвертуйте ціни/капіталізацію в активну фіатну валюту за символом (типово USD). Курси оновлюються ~двічі на день.

Одне з: 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

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати ціну монети

Знімок ціни однієї монети. За бажанням convert в активну фіатну валюту за символом (типово USD).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

Параметри запиту

convert
string необов'язковий
EUR

Символ активної фіатної валюти для відображення цін (типово USD).

GET-запит — тіло запиту відсутнє.

Запит

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"

Історична ціна

Ціна монети в USD на задану дату, зчитана з денної історії (точний день, ±3 дні за замовчуванням — той самий резолвер, який використовує портфель). Лише крипто: фіатні рядки не мають денної історії.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

date
string обов'язковий
2021-04-14

date Дата пошуку (після 2008-12-31, не в майбутньому).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Ринки

Тикери (ринки по кожній біржі) та пари (ринки, агреговані за майданчиками), а також ринки монети та сирі торгові символи по кожній біржі. Усе це — дані-знімки — історії по тикеру/парі не існує. Обсяги в USD — це числа; ціни — це десяткові рядки.

Ринки монети

Усі ринки для монети — тикери, у парі яких монета є базовою АБО котирувальною валютою. Той самий формат рядка та фільтри, що й у List tickers.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

exchange
string необов'язковий
binance-exchange

Обмежити однією біржею за слагом (пропустіть у переліку по біржі, який уже обмежений). Має відповідати регулярному виразу /^[a-z0-9-]{1,120}$/.

pair
integer необов'язковий
1

Обмежити однією парою за id. Має бути щонайменше 1.

instrument
string необов'язковий
spot

Тип інструмента: future, option, swap, spot або margin (множина приймається).

Одне з: future option swap spot margin

search
string необов'язковий
BTC

Пошук за вільним текстом у символі тикера. Не має перевищувати 50 символів.

min_volume
number необов'язковий
1000000

Лише тикери з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише тикери з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_change
number необов'язковий
-50

Лише тикери з відсотковою зміною за 24h на рівні цього значення або вище.

max_change
number необов'язковий
50

Лише тикери з відсотковою зміною за 24h на рівні цього значення або нижче.

sort
string необов'язковий
-volume_usd

Одне поле сортування (з префіксом - для спадання). Сортування за: volume_usd, change_24h, price_usd, updated. Типово -volume_usd. Не має перевищувати 100 символів.

GET-запит — тіло запиту відсутнє.

Запит

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"

Торгові символи монети

Сирі торгові символи монети по кожній біржі — рідко заповнені довідкові дані (покриття за можливістю).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

GET-запит — тіло запиту відсутнє.

Запит

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"

Список тикерів

Окремі ринки по кожній біржі (тикери) з пагінацією. Фільтруйте за біржею, парою, інструментом та діапазонами обсягу/зміни. Обсяги в USD — це числа; ціни — це десяткові рядки.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

exchange
string необов'язковий
binance-exchange

Обмежити однією біржею за слагом (пропустіть у переліку по біржі, який уже обмежений). Має відповідати регулярному виразу /^[a-z0-9-]{1,120}$/.

pair
integer необов'язковий
1

Обмежити однією парою за id. Має бути щонайменше 1.

instrument
string необов'язковий
spot

Тип інструмента: future, option, swap, spot або margin (множина приймається).

Одне з: future option swap spot margin

search
string необов'язковий
BTC

Пошук за вільним текстом у символі тикера. Не має перевищувати 50 символів.

min_volume
number необов'язковий
1000000

Лише тикери з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише тикери з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_change
number необов'язковий
-50

Лише тикери з відсотковою зміною за 24h на рівні цього значення або вище.

max_change
number необов'язковий
50

Лише тикери з відсотковою зміною за 24h на рівні цього значення або нижче.

sort
string необов'язковий
-volume_usd

Одне поле сортування (з префіксом - для спадання). Сортування за: volume_usd, change_24h, price_usd, updated. Типово -volume_usd. Не має перевищувати 100 символів.

GET-запит — тіло запиту відсутнє.

Запит

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"

Список пар

Торгові пари, агреговані за майданчиками, ранжовані за обсягом в USD за 24h. Фільтруйте за слагом монети (базова або котирувальна) та діапазоном обсягу.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

search
string необов'язковий
BTC

Пошук за вільним текстом у символі пари. Не має перевищувати 50 символів.

coin
string необов'язковий
bitcoin

Обмежити парами, де слаг цієї монети є базовим або котирувальним активом. Має відповідати регулярному виразу /^[a-z0-9-]{1,120}$/.

min_volume
number необов'язковий
1000000

Лише пари з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише пари з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

sort
string необов'язковий
-volume_usd

Поле сортування: volume_usd або updated (з префіксом - для спадання). Типово -volume_usd.

Одне з: volume_usd -volume_usd updated -updated

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати деталі пари

Одна пара плюс кожен біржовий тикер, що її містить, упорядковані за обсягом.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
1

Ідентифікатор пари.

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Біржі

Рейтинги бірж, деталі, оцінки довіри, часові ряди та переліки ринків/монет по кожній біржі. Обсяги вказані в USD. Стовпця CEX/DEX немає — type виводиться з таксономії біржі, тому може бути "cex", "dex" або null.

Список бірж

Біржі за рейтингом з обсягом за 24h, домінантністю, кількістю пар/активів та нещодавніми змінами. З пагінацією через оболонку Laravel links + meta.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
cex

Обмежити типом майданчика: cex або dex (визначається через таксономію біржі).

Одне з: cex dex

search
string необов'язковий
binance

Пошук за вільним текстом у назві біржі. Не має перевищувати 100 символів.

min_pairs
integer необов'язковий
100

Лише біржі, що містять щонайменше стільки пар. Має бути щонайменше 0.

max_pairs
integer необов'язковий
2000

Лише біржі, що містять щонайбільше стільки пар. Має бути щонайменше 0.

min_assets
integer необов'язковий
50

Лише біржі, що містять щонайменше стільки активів. Має бути щонайменше 0.

max_assets
integer необов'язковий
1000

Лише біржі, що містять щонайбільше стільки активів. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише біржі з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише біржі з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
1,12

Фільтр до конкретних ідентифікаторів бірж (CSV, до 100). Не має перевищувати 1000 символів.

slugs
string необов'язковий
binance-exchange,gateio

Фільтр до конкретних слагів бірж (CSV, до 100). Не має перевищувати 2000 символів.

sort
string необов'язковий
-volume

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: volume, rank, volume_dominance, change_24h, change_7d, pairs, assets. Не має перевищувати 100 символів.

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати деталі біржі

Повний профіль однієї біржі: рейтинг, обсяг/домінантність, кількість пар та активів, дата established, location, реферальний website і виведений type (cex/dex/null).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
binance-exchange

Слаг біржі.

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати оцінку довіри біржі

Агрегована оцінка довіри score від 0 до 10 та її breakdown за 13 факторами (rank, volume, age, volume_trend, stability, rank_stability, ticker_health, pairs, community, assets, dominance, market_breadth, transparency). Обчислюється для кожної біржі та кешується на 24 години.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
binance-exchange

Слаг біржі.

GET-запит — тіло запиту відсутнє.

Запит

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"

Історія біржі

Часовий ряд обсягу / домінантності / пар / активів (агрегати бірж не містять OHLC). Оберіть interval: minutely, hourly або daily. Термін зберігання — це жорстка властивість конвеєра агрегації — minutely 8 днів, hourly 6 місяців, daily назавжди; коли встановлено limit, ви отримуєте найновіші N рядків у вікні, від найстаріших.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
binance-exchange

Слаг біржі.

Параметри запиту

interval
string необов'язковий
daily

minutely, hourly або daily (типово daily).

start
string необов'язковий
2026-06-01

Нижня межа дати/часу ISO.

end
string необов'язковий
2026-06-30

Верхня межа дати/часу ISO (значення лише з датою означає включно до цього дня).

limit
integer необов'язковий
30

Максимум рядків (1–2000, типово 1000).

GET-запит — тіло запиту відсутнє.

Запит

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"

Спарклайн біржі

Серія спарклайна обсягу біржі за період (типово 7d) — та сама серія, яку відображають рядки бірж на сайті.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
binance-exchange

Слаг біржі.

Параметри запиту

period
string необов'язковий
7d

Одне з 24h, 7d (типово), 30d, 60d, 90d, 180d, 365d.

GET-запит — тіло запиту відсутнє.

Запит

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"

Ринки біржі

Переліки тикерів біржі (її ринки), з пагінацією. Уже обмежено цією біржею — не передавайте тут параметр exchange.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
binance-exchange

Слаг біржі.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

exchange
string необов'язковий
binance-exchange

Обмежити однією біржею за слагом (пропустіть у переліку по біржі, який уже обмежений). Має відповідати регулярному виразу /^[a-z0-9-]{1,120}$/.

pair
integer необов'язковий
1

Обмежити однією парою за id. Має бути щонайменше 1.

instrument
string необов'язковий
spot

Тип інструмента: future, option, swap, spot або margin (множина приймається).

Одне з: future option swap spot margin

search
string необов'язковий
BTC

Пошук за вільним текстом у символі тикера. Не має перевищувати 50 символів.

min_volume
number необов'язковий
1000000

Лише тикери з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише тикери з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_change
number необов'язковий
-50

Лише тикери з відсотковою зміною за 24h на рівні цього значення або вище.

max_change
number необов'язковий
50

Лише тикери з відсотковою зміною за 24h на рівні цього значення або нижче.

sort
string необов'язковий
-volume_usd

Одне поле сортування (з префіксом - для спадання). Сортування за: volume_usd, change_24h, price_usd, updated. Типово -volume_usd. Не має перевищувати 100 символів.

GET-запит — тіло запиту відсутнє.

Запит

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"

Монети біржі

Монети, представлені на біржі, повертаються у тому самому форматі, що й List coins, і приймають ті самі фільтри/сортування.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
binance-exchange

Слаг біржі.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
coin

Обмежити одним типом активу: coin або token.

Одне з: coin token

status
string необов'язковий
active

Статус лістингу: active, delisted, untracked, progressing, awaiting або preparing. Типово всі публічні статуси.

Одне з: active delisted untracked progressing awaiting preparing

search
string необов'язковий
bitcoin

Пошук за вільним текстом у назві або символі. Не має перевищувати 100 символів.

min_price
number необов'язковий
0.5

Лише монети з ціною на рівні цього значення в USD або вище. Має бути щонайменше 0.

max_price
number необов'язковий
100000

Лише монети з ціною на рівні цього значення в USD або нижче. Має бути щонайменше 0.

min_marketcap
number необов'язковий
1000000

Лише монети з капіталізацією в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_marketcap
number необов'язковий
5000000000000

Лише монети з капіталізацією в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише монети з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише монети з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
38,39

Фільтр до конкретних ідентифікаторів монет (CSV, до 100 селекторів разом зі slugs/symbols). Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Фільтр до конкретних слагів монет (CSV, до 100 селекторів разом). Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Фільтр до конкретних символів монет (CSV, без урахування регістру, до 100 селекторів разом). Не має перевищувати 1000 символів.

sort
string необов'язковий
-marketcap

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: marketcap, rank, price, volume_24h, change_24h, change_7d. Не має перевищувати 100 символів.

interval
string необов'язковий
24h

Вікно рухів лише для /coins/gainers та /coins/losers: 24h або 7d.

Одне з: 24h 7d

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Гаманці

Огляди криптогаманців — оцінка огляду score, кількість підтримуваних активів, кількість переваг/недоліків, модель ціни й дата релізу, а також згрупована таксономія тегів у відповідях detail/compare. meta.top_score — це найвища оцінка серед усіх гаманців (використовуйте її для нормалізації оцінок у діапазон 0–1).

Список гаманців

Оцінені гаманці з оцінкою, кількістю активів, кількістю переваг/недоліків, моделлю ціни, статусом та датою релізу. З пагінацією через оболонку Laravel links + meta, плюс meta.top_score.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

search
string необов'язковий
ledger

Пошук за вільним текстом у назві гаманця. Не має перевищувати 100 символів.

min_score
integer необов'язковий
50

Лише гаманці з оцінкою огляду на рівні цього значення або вище. Має бути щонайменше 0.

max_score
integer необов'язковий
214

Лише гаманці з оцінкою огляду на рівні цього значення або нижче. Має бути щонайменше 0.

tags
string необов'язковий
12,34

Фільтр за таксономією тегів: ідентифікатори груп категорій, розділені комами (ті самі ідентифікатори, які надсилають фасетні фільтри на сайті). Не має перевищувати 1000 символів.

ids
string необов'язковий
175,317

Фільтр до конкретних ідентифікаторів гаманців (CSV, до 100). Не має перевищувати 1000 символів.

slugs
string необов'язковий
frostsnap,coin98-fusion-card

Фільтр до конкретних слагів гаманців (CSV, до 100). Не має перевищувати 2000 символів.

sort
string необов'язковий
-score

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: score, released_at, assets, pros, cons. Не має перевищувати 100 символів.

GET-запит — тіло запиту відсутнє.

Запит

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"

Хронологія релізів гаманців

Список гаманців, закріплений за спаданням released_at (гаманці без дати — останні). Той самий формат рядка й оболонка пагінації, що й у List wallets.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

search
string необов'язковий
ledger

Пошук за вільним текстом у назві гаманця. Не має перевищувати 100 символів.

min_score
integer необов'язковий
50

Лише гаманці з оцінкою огляду на рівні цього значення або вище. Має бути щонайменше 0.

max_score
integer необов'язковий
214

Лише гаманці з оцінкою огляду на рівні цього значення або нижче. Має бути щонайменше 0.

tags
string необов'язковий
12,34

Фільтр за таксономією тегів: ідентифікатори груп категорій, розділені комами (ті самі ідентифікатори, які надсилають фасетні фільтри на сайті). Не має перевищувати 1000 символів.

ids
string необов'язковий
175,317

Фільтр до конкретних ідентифікаторів гаманців (CSV, до 100). Не має перевищувати 1000 символів.

slugs
string необов'язковий
frostsnap,coin98-fusion-card

Фільтр до конкретних слагів гаманців (CSV, до 100). Не має перевищувати 2000 символів.

sort
string необов'язковий
-score

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: score, released_at, assets, pros, cons. Не має перевищувати 100 символів.

GET-запит — тіло запиту відсутнє.

Запит

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"

Порівняти гаманці

Порівняння 2–4 гаманців пліч-о-пліч із їхньою повною згрупованою таксономією тегів. data[] зберігає запитаний порядок слагів, тож споживачі можуть відображати стовпці позиційно.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

slugs
string обов'язковий
frostsnap,coin98-fusion-card

2–4 різні слаги гаманців, розділені комами.

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати деталі гаманця

Повний профіль одного гаманця, включно зі згрупованою таксономією тегів: categories — це список {group, tags[]}, де кожен тег має слаг, назву та необов'язкове значення. meta.top_score — це найвища оцінка серед усіх гаманців.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
frostsnap

Слаг гаманця.

GET-запит — тіло запиту відсутнє.

Запит

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"

Монети, підтримувані гаманцем

Монети, які підтримує гаманець, повертаються у тому самому форматі, що й List coins, і приймають ті самі фільтри/сортування.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
frostsnap

Слаг гаманця.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

type
string необов'язковий
coin

Обмежити одним типом активу: coin або token.

Одне з: coin token

status
string необов'язковий
active

Статус лістингу: active, delisted, untracked, progressing, awaiting або preparing. Типово всі публічні статуси.

Одне з: active delisted untracked progressing awaiting preparing

search
string необов'язковий
bitcoin

Пошук за вільним текстом у назві або символі. Не має перевищувати 100 символів.

min_price
number необов'язковий
0.5

Лише монети з ціною на рівні цього значення в USD або вище. Має бути щонайменше 0.

max_price
number необов'язковий
100000

Лише монети з ціною на рівні цього значення в USD або нижче. Має бути щонайменше 0.

min_marketcap
number необов'язковий
1000000

Лише монети з капіталізацією в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_marketcap
number необов'язковий
5000000000000

Лише монети з капіталізацією в USD на рівні цього значення або нижче. Має бути щонайменше 0.

min_volume
number необов'язковий
1000000

Лише монети з обсягом за 24h в USD на рівні цього значення або вище. Має бути щонайменше 0.

max_volume
number необов'язковий
100000000000

Лише монети з обсягом за 24h в USD на рівні цього значення або нижче. Має бути щонайменше 0.

ids
string необов'язковий
38,39

Фільтр до конкретних ідентифікаторів монет (CSV, до 100 селекторів разом зі slugs/symbols). Не має перевищувати 1000 символів.

slugs
string необов'язковий
bitcoin,ethereum

Фільтр до конкретних слагів монет (CSV, до 100 селекторів разом). Не має перевищувати 2000 символів.

symbols
string необов'язковий
BTC,ETH

Фільтр до конкретних символів монет (CSV, без урахування регістру, до 100 селекторів разом). Не має перевищувати 1000 символів.

sort
string необов'язковий
-marketcap

Поля сортування, розділені комами; з префіксом - для спадання. Сортування за: marketcap, rank, price, volume_24h, change_24h, change_7d. Не має перевищувати 100 символів.

interval
string необов'язковий
24h

Вікно рухів лише для /coins/gainers та /coins/losers: 24h або 7d.

Одне з: 24h 7d

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Глобальний ринок

Загальноринкові агрегати — сукупна капіталізація та обсяг, кількість активів/бірж/пар/ринків, домінантність BTC/ETH із топ-3 за рангом, ринковий показник страху та жадібності, а також теплова карта топ-100 та історія капіталізації/обсягу.

Знімок глобального ринку

Одноразовий огляд ринку: сукупна капіталізація та обсяг за 24h, кількість криптовалют / токенів / бірж / пар / ринків, dominance (частка BTC та ETH плюс top3 за рангом) та ринковий показник fear_greed.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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

Теплова карта ринку

Рядки деревної карти топ-100 плюс обрамлювальна статистика (сукупна капіталізація/обсяг, домінантність і ринкова оцінка страху та жадібності) — API-двійник теплової карти на сайті.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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"

Історія глобальної капіталізації / обсягу

Загальноринковий часовий ряд для marketcap або volume. Деталізація залежить від period: 24h = half-hourly, 7d = hourly, 30d/all = daily (детальніші агрегати очищуються).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

metric
string обов'язковий
marketcap

Який ряд: marketcap або volume.

Параметри запиту

period
string необов'язковий
7d

24h, 7d, 30d або all (типово 24h).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Настрої

Ринкові та по-монетні індекси настроїв. Страх та жадібність і бичачий/ведмежий — це ЗНІМКИ з оновленням кожні 15 хвилин — існує лише поточний показник, часового ряду для них немає. Альтсезон має повну денну історію. indicators — це загальноринковий технічний підсумок.

Підсумки голосів спільноти

Бичачі/ведмежі підсумки голосів спільноти по монеті за рухоме вікно 24h.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

GET-запит — тіло запиту відсутнє.

Запит

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"

Проголосувати за настрій

Реєструє голос власника ключа щодо настрою по монеті. Один голос на власника ключа для однієї монети у межах рухомого вікна 24h — повторне голосування у межах вікна оновлює наявний голос.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

Параметри тіла

vote
string обов'язковий
bullish

Ваш настрій: bullish або bearish.

Запит

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\"
}"

Індекс страху та жадібності

Поточний показник страху та жадібності (15-хвилинний знімок — без історії). Пропустіть coin для загальноринкового індексу або передайте слаг монети для показника по монеті. intervals містить під-оцінки 7d/30d та їхню покомпонентну розбивку.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

coin
string необов'язковий
bitcoin

Слаг монети для показника по монеті; пропустіть для ринкового індексу.

GET-запит — тіло запиту відсутнє.

Запит

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"

Індекс бичачого / ведмежого настрою

Поточний показник бичачого/ведмежого настрою (15-хвилинний знімок — без історії). Пропустіть coin для загальноринкового індексу або передайте слаг монети для показника по монеті.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

coin
string необов'язковий
bitcoin

Слаг монети для показника по монеті; пропустіть для ринкового індексу.

GET-запит — тіло запиту відсутнє.

Запит

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"

Індекс альтсезону

Поточний показник альтсезону (кількість монет, що обійшли BTC серед топ-100), із необов'язковою денною history. На відміну від страху та жадібності, альтсезон має повну денну історію — передайте days, щоб її включити.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

days
integer необов'язковий
30

Кількість днів денної історії для включення (1–365; 0/пропуск = лише поточні).

GET-запит — тіло запиту відсутнє.

Запит

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"

Підсумок ринкових індикаторів

Загальноринковий технічний підсумок — 25 категорій індикаторів, зведених разом, кожна зі своїм поточним станом, оцінкою та даними категорії.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Індикатори

По-монетні технічні індикатори — знімок з кількома індикаторами плюс денний часовий ряд для кожного сімейства. Усі сімейства — це ДЕННІ ряди, обчислені з денних свічок (повний термін зберігання; молоді активи повертають розігрівальні null, доки не набереться достатньо історії). Сімейства цінового масштабу (sma, vwap, macd, obv) видають десяткові рядки; обмежені осцилятори видають числа. Деякі періоди з довгим вікном потребують платного тарифу (див. ендпоінт сімейства).

Знімок індикаторів

Знімок з кількома індикаторами — останній state кожної категорії індикаторів (bullish/bearish/sheepish…), score та сирі data в одному корисному навантаженні.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

GET-запит — тіло запиту відсутнє.

Запит

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"

Серія сімейства індикаторів

Денний часовий ряд одного сімейства індикаторів. Сімейства з кількома вікнами приймають period, і дійсні вікна відрізняються для кожного сімейства: 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. Сімейства з одним рядом (MACD, OBV, ADX, VWAP, CMF) ігнорують period. Молоді монети повертають початкові розігрівальні null.

Деякі довгі вікна потребують платного тарифу: RSI та Stoch-RSI на 21/28 днів і 30-денні вікна волатильності потребують Starter або вищого — запит їх на тарифі Free повертає 403 з кодом plan_required.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг монети.

family
string обов'язковий
rsi

Сімейство індикаторів — одне з rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf.

Параметри запиту

period
integer необов'язковий
14

Довжина вікна (лише там, де сімейство має вікна; має бути одним із дійсних вікон цього сімейства).

start
string необов'язковий
2026-06-01

Нижня межа дати ISO.

end
string необов'язковий
2026-06-30

Верхня межа дати ISO.

limit
integer необов'язковий
30

Максимум рядків (1–1000, типово 365).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Ліквідації

Ліквідації деривативів. Наразі джерело охоплює лише свопові ринки OKX (зазначено в кожному meta.note). СИРИЙ потік (список /liquidations та погодинна розбивка) очищується через ~48 годин; денні агрегати зберігаються назавжди. Агрегати за сьогодні неповні й оновлюються кожні ~15 хвилин.

Потік ліквідацій

Сирий потік ліквідацій (~останні 48h, потім очищується), найновіші спершу. Наразі джерело охоплює свопові ринки OKX. Ціни — це десяткові рядки. meta містить поля пагінації, а також retention і note.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1). Має бути щонайменше 1.

per_page
integer необов'язковий
50

Рядків на сторінку. Ліміт залежить від тарифу (Free 100, Starter/Pro 250); його перевищення повертає 422, а не обрізає значення. Має бути щонайменше 1. Не має перевищувати 100.

exchange
string необов'язковий
okx

Обмежити однією біржею за слагом. Наразі джерело охоплює свопові ринки OKX. Має відповідати регулярному виразу /^[a-z0-9-]{1,120}$/.

instrument
string необов'язковий
swap

Тип інструмента: future, option, swap, spot або margin.

Одне з: future option swap spot margin

position
string необов'язковий
short

Сторона ліквідованої позиції: long або short.

Одне з: long short

order
string необов'язковий
buy

Сторона виконання, що спричинила ліквідацію: buy або sell.

Одне з: buy sell

symbol
string необов'язковий
BTC

Збіг за префіксом instId майданчика (напр. BTC збігається з BTC-USDT-SWAP). Має відповідати регулярному виразу /^[A-Za-z0-9$.-]{1,25}$/.

min_usd
number необов'язковий
1000

Лише ліквідації зі значенням в USD на рівні цього порога або вище. Має бути щонайменше 0.

GET-запит — тіло запиту відсутнє.

Запит

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"

Погодинні ліквідації

Погодинні підсумки long/short в USD за сирим потоком. Оскільки сирий потік очищується через ~48h, hours обмежено 48. Наразі джерело охоплює свопові ринки OKX.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

hours
integer необов'язковий
24

Вікно перегляду назад у годинах (1–48, типово 24).

GET-запит — тіло запиту відсутнє.

Запит

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"

Денні ліквідації

Денні агрегати (зберігаються назавжди), підсумовані по біржах/інструментах за день — total/long/short USD плюс кількість лонг/шорт позицій. Рядок за сьогодні неповний і оновлюється кожні ~15 хвилин. Наразі джерело охоплює свопові ринки OKX.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

days
integer необов'язковий
30

Кількість календарних днів, включно з сьогоднішнім (1–365, типово 30).

GET-запит — тіло запиту відсутнє.

Запит

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"

Зведення ліквідацій за сьогодні

Сьогодні на цей момент — total/long/short USD, кількість позицій та dominance long проти short. Показники неповні й оновлюються кожні ~15 хвилин; data дорівнює null, доки не буде зафіксовано першу ліквідацію дня. Наразі джерело охоплює свопові ринки OKX.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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"

Чистий потік ліквідацій

Потік ліквідацій long проти short в USD за день у межах вікна. Наразі джерело охоплює свопові ринки OKX.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

days
integer необов'язковий
30

Кількість календарних днів, включно з сьогоднішнім (1–90, типово 30).

GET-запит — тіло запиту відсутнє.

Запит

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"

Топові ліквідовані монети

Топові монети за обсягом ліквідацій у нещодавньому вікні, з розподілом long/short в USD по кожній монеті. Наразі джерело охоплює свопові ринки OKX.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

hours
integer необов'язковий
24

Вікно перегляду назад у годинах (1–48, типово 24).

limit
integer необов'язковий
8

Кількість монет для повернення (1–20, типово 8).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Конвертація

Конвертуйте між будь-якими двома активними активами (крипто ТА фіат) і отримайте перелік валют, придатних як плечі конвертації. Значення — це десяткові рядки. Курси фіатних валют оновлюються ~двічі на день; курси криптовалют — ~щохвилини.

Конвертація між активами

Серверна конвертація між будь-якими двома активними активами (крипто ТА фіат). to приймає CSV для конвертації в кілька цілей; зворотна конвертація — це просто заміна from/to. Конвертація лінійна, тож value = unit_rate * amount. Курси фіатних валют оновлюються ~двічі на день; курси криптовалют — ~щохвилини.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

from
string обов'язковий
bitcoin

Слаг вихідного активу.

to
string обов'язковий
ethereum

Слаг(и) цільового активу, розділені комами (до 10).

amount
number необов'язковий
2.5

Кількість вихідного активу для конвертації (типово 1).

GET-запит — тіло запиту відсутнє.

Запит

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"

Список фіатних валют

Активні фіатні валюти з їхніми курсами до USD: rate_per_usd (одиниць за USD) та обернене значення usd_value. Курси фіатних валют оновлюються ~двічі на день.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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

Список курсів конвертації

Валюти порівняння, придатні як плечі конвертації — топові фіати, монети та токени — кожна з нормалізованим usd_value (USD за одну одиницю). Значення монет/токенів оновлюються ~щохвилини; повільні фіатні курси кешуються окремо (~двічі на день).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Калькулятори

Серверні фінансові калькулятори, що віддзеркалюють вебінструменти: DCA, прибуток/збиток і позика (які зчитують кешовані ринкові дані), а також математика складних відсотків і стейкінгу без збереження стану.

Калькулятор DCA

Бектест усереднення вартості (DCA) на реальній денній історії цін монети: одна купівля на суму amount за кожен interval між start і end. Передайте series=true, щоб включити повну серію по кожній купівлі.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

amount
number обов'язковий
100

USD, витрачено на одну купівлю (0.01–1,000,000,000).

interval
string обов'язковий
weekly

Періодичність купівлі: daily, weekly, monthly, quarterly або yearly.

start
string обов'язковий
2024-01-01

date Дата першої купівлі (після 2008-12-31).

end
string необов'язковий
2025-01-01

date Дата останньої купівлі (типово сьогодні).

series
boolean необов'язковий
false

Включити серію по кожній купівлі у корисне навантаження.

GET-запит — тіло запиту відсутнє.

Запит

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"

Калькулятор прибутку / збитку

Що дала купівля з наступним продажем між двома історичними датами, з використанням реальних цін монети на ці дати. Комісії — це фіксовані суми в USD, а не відсотки.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

amount
number обов'язковий
1000

Інвестовано в USD на дату buy_date (0.01–1,000,000,000).

buy_date
string обов'язковий
2023-01-01

date Дата купівлі.

sell_date
string обов'язковий
2025-01-01

date Дата продажу (у день або після buy_date).

buy_fee
number необов'язковий
10

Фіксована комісія за купівлю в USD (типово 0).

sell_fee
number необов'язковий
10

Фіксована комісія за продаж в USD (типово 0).

GET-запит — тіло запиту відсутнє.

Запит

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"

Калькулятор складних відсотків

Чиста математика — без ринкових даних. Зверніть увагу, що ставка застосовується ЗА ПЕРІОД НАРАХУВАННЯ (домовленість вебкалькулятора), а не за рік.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

principal
number обов'язковий
10000

Початковий баланс в USD.

rate
number обов'язковий
1

Відсоткова ставка у % за період нарахування.

duration
integer обов'язковий
5

Тривалість прогнозу (роки обмежені 50).

duration_unit
string необов'язковий
years

years (типово) або months.

compound_frequency
string необов'язковий
monthly

daily, weekly, monthly (типово), quarterly або annually.

contribution
number необов'язковий
100

Регулярний депозит в USD (типово 0).

contribution_frequency
string необов'язковий
monthly

daily, weekly, monthly (типово), quarterly або annually.

GET-запит — тіло запиту відсутнє.

Запит

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"

Калькулятор «позика проти продажу»

Позика під заставу крипти проти її продажу — порівнює обидва сценарії, використовуючи ПОТОЧНУ ціну монети. Інформаційний прогноз, а не фінансова порада.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

crypto_amount
number обов'язковий
2

Скільки монети ви утримуєте.

needed_cash
number обов'язковий
50000

USD, які потрібно вивільнити.

term_months
integer необов'язковий
36

Термін позики у місяцях (типово 36).

interest_rate
number необов'язковий
10

APR позики у % (типово 10).

ltv
number необов'язковий
50

Співвідношення позики до вартості (LTV) у % (типово 50).

expected_growth
number необов'язковий
25

Очікуване зростання ціни монети за термін у % (типово 25).

tax_rate
number необов'язковий
25

Податок на приріст капіталу у %, що застосовується до продажу (типово 25).

GET-запит — тіло запиту відсутнє.

Запит

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"

Калькулятор винагород за стейкінг

Чиста математика — винагороди за стейкінг із необов'язковим нарахуванням складних відсотків та комісією валідатора. Ринкові дані не зчитуються.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

amount
number обов'язковий
1000

Кількість у стейкінгу, в одиницях застейканого активу.

period
number обов'язковий
2

Тривалість періоду стейкінгу (обмежена еквівалентом 50 років).

period_unit
string необов'язковий
years

years (типово), months або days.

apy
number обов'язковий
5

Заявлений APY у %.

compound_frequency
string необов'язковий
monthly

never, daily, weekly, monthly (типово) або yearly.

commission
number необов'язковий
10

Комісія валідатора у %, що стягується з винагород (типово 0).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Редакційний контент

Редакційні статті — лише опубліковані (ACTIVE). locale обирає мову контенту з англійською мовою за замовчуванням для кожного поля (у відповіді зазначено, який locale фактично переміг). Статті можна фільтрувати за тегом або за слагом пов'язаної монети/біржі/гаманця. Читання через API навмисно НЕ збільшують лічильники переглядів.

Відео про монету

Добірка відео, прив'язаних до монети (вкладка «Відео» на сторінці монети), з пагінацією.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1).

per_page
integer необов'язковий
10

Рядків на сторінку (1–50, типово 10).

type
string необов'язковий
review

Фільтр за типом відео (напр. overview, tutorial, explainer, review, analysis, news).

search
string необов'язковий
halving

Пошук за вільним текстом у назві.

GET-запит — тіло запиту відсутнє.

Запит

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"

Хронологія інсайтів монети

Хронологія інсайтів монети — те саме корисне навантаження, яке використовує панель інсайтів сторінки активу, з вікном за offset/limit.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

Параметри запиту

locale
string необов'язковий
en

Мова контенту (за замовчуванням англійська).

offset
integer необов'язковий
0

Рядків для пропуску (0–500, типово 0).

limit
integer необов'язковий
5

Рядків для повернення (1–50, типово 5).

GET-запит — тіло запиту відсутнє.

Запит

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"

Список статей

Опубліковані статті, найновіші спершу, з пагінацією. Фільтруйте за tag або за слагом пов'язаної coin / exchange / wallet, чи за вільним текстом search. Кожен рядок — це стисле зведення (назва, підзаголовок, теги, час читання, головне зображення, пов'язані сутності, дати).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1).

per_page
integer необов'язковий
20

Рядків на сторінку (1–50, типово 20).

locale
string необов'язковий
en

Мова контенту (за замовчуванням англійська).

tag
string необов'язковий
guide

Фільтр за тегом: news, guide, tutorial, explainer, analysis, review, trading, overview або information.

coin
string необов'язковий
bitcoin

Фільтр до статей, пов'язаних із цим слагом монети.

exchange
string необов'язковий
binance-exchange

Фільтр до статей, пов'язаних із цим слагом біржі.

wallet
string необов'язковий
frostsnap

Фільтр до статей, пов'язаних із цим слагом гаманця.

search
string необов'язковий
halving

Пошук за вільним текстом у заголовку/підзаголовку.

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати статтю

Одна опублікована стаття з її повним текстом, тегами, головним зображенням, лічильниками корисності та пов'язаними сутностями. locale обирає мову контенту з англійською мовою за замовчуванням для кожного поля (у відповіді зазначено, який locale фактично переміг).

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
what-is-bitcoin

Слаг статті.

Параметри запиту

locale
string необов'язковий
en

Мова контенту (за замовчуванням англійська).

GET-запит — тіло запиту відсутнє.

Запит

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"

Надіслати відгук про статтю

Реєструє лайк/дизлайк на статті — ті самі лічильники, що використовують кнопки корисності на сайті. Обмеження за ключем застосовується вище за потоком.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

slug
string обов'язковий
what-is-bitcoin

Слаг статті.

Параметри тіла

helpful
boolean обов'язковий
true

true — корисно, false — не корисно.

Запит

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
}"

Отримати відео

Одне добірне відео з його YouTube id, назвою, типом, тривалістю та монетами/біржами/гаманцями, до яких воно прив'язане.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
87

Ідентифікатор відео.

GET-запит — тіло запиту відсутнє.

Запит

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"

Список інсайтів

Згенеровані ШІ ринкові інсайти з пагінацією. Фільтруйте за type, слагом пов'язаної монети coin чи вільним текстом search; locale обирає мову заголовка/резюме з англійською мовою за замовчуванням.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1).

per_page
integer необов'язковий
20

Рядків на сторінку (1–50, типово 20).

locale
string необов'язковий
en

Мова контенту (за замовчуванням англійська).

type
string необов'язковий
per_asset

Фільтр за типом інсайту: per_asset, market_overview або narrative.

coin
string необов'язковий
bitcoin

Фільтр до інсайтів про цей слаг монети.

search
string необов'язковий
etf

Пошук за вільним текстом у заголовку.

sort
string необов'язковий
first_reported

Порядок сортування: first_reported (типово) або last_updated.

GET-запит — тіло запиту відсутнє.

Запит

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"

Отримати інсайт

Один інсайт із повним корисним навантаженням — заголовок, резюме, хронологія статей-джерел та пов'язані монети.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
101

Ідентифікатор інсайту.

Параметри запиту

locale
string необов'язковий
en

Мова контенту (за замовчуванням англійська).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Сигнали

CRUD цінових сигналів — ті самі сигнали, якими керує вебзастосунок. Сигнали витрачають баланс інвентарю сигналів власника ключа, мають тип TARGET лише на монетах, а захист above/below відносно поточної вартості блокує сигнали, що спрацювали б миттєво. Прив'язані до ключа (API-ключ визначає власника) і ніколи не кешуються у відповіді.

Список сигналів

Сигнали власника ключа, найновіші спершу, з пагінацією. Фільтруйте за status, direction або каналом notification.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1).

per_page
integer необов'язковий
25

Рядків на сторінку (1–100, типово 25).

status
string необов'язковий
active

Фільтр за станом: active або triggered.

direction
string необов'язковий
above

Фільтр за напрямком спрацювання: above або below.

notification
string необов'язковий
email

Фільтр за каналом доставки: email, push або webhook.

GET-запит — тіло запиту відсутнє.

Запит

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"

Створити сигнал

Створює сигнал типу TARGET на монету та витрачає один слот сигналу з балансу власника ключа. Цільове значення перевіряється відносно поточної вартості монети, тож сигнал не може спрацювати миттєво сам по собі: сигнал above має націлюватися на значення більше за поточне, а сигнал below — менше.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри тіла

name
string обов'язковий
BTC six figures

Мітка для сигналу (максимум 255 символів).

coin
string обов'язковий
bitcoin

Слаг-ідентифікатор монети.

metric
string обов'язковий
rate

Відстежувана метрика: rate, volume або marketcap.

direction
string обов'язковий
above

Напрямок спрацювання: above або below.

target
number обов'язковий
100000

Порогове значення (має бути на боці direction відносно поточної вартості монети).

notification
string обов'язковий
email

Канал доставки: email, push або webhook.

Запит

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\"
}"

Видалити сигнал

Видаляє один із сигналів власника ключа та повертає слот сигналу, який він займав.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
42

Ідентифікатор сигналу.

Запит

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 ендпоінтів

Webhooks

Bitculator надсилає кожну подію методом POST у форматі JSON із заголовком HMAC-підпису:

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

Перевірте його, повторно обчисливши HMAC над "." за допомогою секрету вашого ендпоінта та порівнявши за постійний час; відхиліть, якщо t старіший за кілька хвилин (захист від повторного відтворення). Приклад (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);

Підтримувані події: alarm.triggered. Доставки повторюються 3× з експоненційною затримкою; ендпоінт автоматично вимикається після 10 послідовних невдалих доставок.

Список ендпоінтів вебхуків

Ендпоінти вебхуків власника ключа, найновіші спершу. Секрети для підпису ніколи не включаються — кожен секрет показують рівно один раз, під час створення.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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

Створити ендпоінт вебхука

Реєструє HTTPS-ендпоінт (максимум 5 на обліковий запис) для доставки подій. У відповіді міститься secret для підпису — це ЄДИНИЙ раз, коли його показують, тож збережіть його негайно.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри тіла

url
string обов'язковий
https://example.com/webhooks/bitculator

URL доставки HTTPS. Лише публічні хости — внутрішні/приватні адреси відхиляються.

events
string[] обов'язковий
["alarm.triggered"]

Події для підписки. Дозволені значення: alarm.triggered.

Запит

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\"
    ]
}"

Видалити ендпоінт вебхука

Видаляє один із ендпоінтів вебхуків власника ключа. Відкладені доставки до нього скасовуються.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
7

Ідентифікатор ендпоінта вебхука.

Запит

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

Надіслати тестову подію

Надсилає підписану тестову подію alarm.triggered (test: true у корисному навантаженні, справжні заголовки підпису), щоб отримувачів можна було перевірити наскрізно.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
7

Ідентифікатор ендпоінта вебхука.

Запит

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"

Журнал доставок вебхука

Спроби доставки ендпоінта (зберігаються 30 днів), найновіші спершу, з пагінацією.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

Параметри шляху

id
integer обов'язковий
7

Ідентифікатор ендпоінта вебхука.

Параметри запиту

page
integer необов'язковий
1

Номер сторінки (починаючи з 1).

per_page
integer необов'язковий
25

Рядків на сторінку (1–100, типово 25).

GET-запит — тіло запиту відсутнє.

Запит

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 ендпоінтів

Мета

Мета та інтроспекція API: автентифікований ping для перевірки ключа та стека middleware, використання/квота поточного ключа й машинозчитувана специфікація OpenAPI.

Специфікація OpenAPI

Машинозчитуваний документ OpenAPI 3 для цього API у форматі JSON — спрямуйте кодогенератор чи API-інструменти на цей URL. Публічний: ключ не потрібен.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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

Автентифікована пуста операція для наскрізної перевірки ключа Data API (auth.api → обмеження сплесків за тарифом → місячна квота). Вона враховується у квоті, як і будь-який інший виклик.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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

Використання ключа та квота

Інтроспекція використання для власника ключа, що викликає: тариф Data API, його місячний ліміт, використано та залишок (завжди відповідають заголовкам X-Quota-*), вікно поточного періоду та розбивки по ендпоінтах / по токенах. Використання embed-віджетів має власний тариф і пул — воно ніколи не з'являється тут.

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

Ключі працюють лише як Bearer і несуть дозвіл data-api — зберігайте їх на боці сервера.

GET-запит — тіло запиту відсутнє.

Запит

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