WhiteBIT API - це інструмент автоматизації, який дає змогу розробникам створювати програми та додатки для взаємодії з нашою біржею. З його допомогою можна виконувати такі дії, як-от: створення та управління ордерами на купівлю і продаж криптовалют, отримання інформації про ринок, баланс облікового запису й багато іншого.

Як використовувати WhiteBIT API?

Перш перейти до використання API, потрібно увімкнути двофакторну аутентифікацію (2FA) на акаунті.

Після цього потрібно згенерувати API ключі, які слугують для аутентифікації користувача та забезпечення інтеграції з API.

Для активації ключів дотримуйтесь простих інструкцій:

• Перейдіть у розділ налаштування API у вашому обліковому записі та виберіть "Редагувати" у відповідній секції;
• Після натискання "Згенерувати ключ API", введіть свій код 2FA;
• У вікні, що з'явилося, ви побачите пару API ключів - обов'язково збережіть їх, оскільки вони знадобляться для подальшої аутентифікації операцій в API інтерфейсі.

Переконайтеся, що ви надійно зберігаєте свій Секретний ключ, оскільки після закриття цієї сторінки він буде недоступний для відновлення. Водночас ваш Публічний ключ завжди доступний, і він не несе загрози під час передавання третім особам. На відміну від Секретного ключа, Публічний ключ сам по собі практично не створює підстав для небажаних дій.

• На цій же сторінці ви також можете вибрати кінцеві точки (endpoint), які ви плануєте використовувати. З метою тестування API ключів рекомендується вибрати всі доступні кінцеві точки, оскільки в майбутньому ви зможете відредагувати цей вибір. Більш детальна інформація про кінцеві точки буде представлена далі в статті;
• Потім, підтвердьте свої дії, ввівши код 2FA;
• І ось, ваші API ключі готові до використання!

Після створення пари API ключів також можна змінити IP-доступ. За допомогою функції обмеження доступу за IP-адресами можна внести власні IPv4 і IPv6 адреси до списку довірених IP-адрес.

У разі активації цієї функції, якщо запит на отримання ключів API буде надіслано з іншої IP-адреси, ключі API автоматично деактивуються. На електронну адресу буде надіслано повідомлення із зазначенням публічного ключа та IP-адреси, з якої було надіслано запит.

Якщо ця IP-адреса належить вам і є довіреною, то API можна знову активувати, додавши її до списку довірених IP-адрес.

Загалом можна додати до списку довірених IP-адрес до 20 адрес.

Якщо повернутися до списку доступних Кінцевих точок (endpoint) для використання, варто звернути увагу, що кожна з представлених категорій і підкатегорій відповідає за свою групу операцій для управління акаунтом на біржі. Ви можете створювати й використовувати ваші ключі для виконання операцій в одній або декількох із таких доступних категорій:

• Поповнення
• Виведення
• Переказ між балансами
• Баланс та історія гаманця
• Коди
• Торговий баланс та історія
• Управління ордерами

Детальнішу інформацію про функціонал API нашої біржі можна знайти в технічній інструкції, представленій у простому і доступному форматі.

Розширена документація також розміщена в загальнодоступному репозиторії програмного забезпечення на GitHub.

Для тестування функціонала нашого API ви також можете скористатися DEMO-токенами.

WhiteBIT Webhook

Webhook використовується для отримання зворотного зв'язку від сервера про виконання різних процесів на вашому акаунті, як-от успішне виведення коштів чи активація WB-коду.

Для активації ключів Webhook необхідно виконати аналогічні кроки, як і для API ключів у розділі налаштувань Webhook у вашому акаунті. Є кілька способів активації:

• Додавання публічного ключа до запису домену TXT, зазначеного під час створення ключа;
• Додавання файлу "whiteBIT-verification.txt" із вмістом вашого публічного ключа Webhook у кореневу папку вашого сайту;
• Створення кінцевої точки "check-wb-webhooks" на вашому сервері, яка повертатиме відкритий ключ Webhook.

Для початку активації ключа Webhook вам потрібно створити його на біржі. Варто враховувати, що створити можна тільки один ключ Webhook. Щоб це зробити, виконайте такі кроки:

• Перейдіть у розділ налаштувань Webhook у вашому обліковому записі та виберіть "Редагувати" у відповідній секції;
• Як і при створенні ключів API, обов'язково збережіть Секретний ключ у безпечному місці. Після закриття сторінки кнопкою "Підтвердити", Секретний ключ більше не буде доступний;
• Готово! Ключі Webhook буде створено.

Зверніть увагу, що, так само як і у випадку з ключами API, створення ключа Webhook не вмикає його автоматично. Необхідно перевести повзунок в активне положення, щоб активувати Webhook.

Детальнішу інформацію про налаштування та використання Webhook можна знайти у відповідному розділі нашої Webhook документації.

Технічний огляд потоку WebSocket із найкращими цінами Bid/Ask у реальному часі

Доступ до ринкових даних у реальному часі є критично важливим для високочастотної торгівлі та автоматизованих торгових систем. Щоб задовольнити цю потребу, ми реалізували окремий потік WebSocket, який транслює актуальні оновлення найкращих цін купівлі (bid) і продажу (ask) для всіх підтримуваних ринків. Цей потік оптимізований для роботи з низькою затримкою та високою надійністю, що дозволяє торговим системам приймати рішення на основі найактуальнішої інформації про ціни.

Що пропонує ця функція?

Потік WebSocket з найкращими цінами Bid/Ask забезпечує безперервний стрім даних, який відображає топ-ціни книги ордерів для кожного торгового інструменту. Кожне оновлення містить найвищу доступну ціну купівлі (best bid) і найнижчу доступну ціну продажу (best ask), відповідні обсяги та ідентифікатор торгової пари. Структура повідомлень оптимізована для передачі лише найрелевантніших даних, що дозволяє уникати зайвого «шуму», зберігаючи при цьому точність і швидкість.

Кожне повідомлення містить дві мітки часу для забезпечення повної прозорості та підтримки операцій, чутливих до затримок. Перша — це час події (Event Time), який позначає момент, коли наш сервер WebSocket надіслав повідомлення. Друга — це час оновлення (Update Time), який вказує, коли дані про ціни були востаннє змінені на рівні метчингового двигуна. Такий підхід із подвійною міткою часу дозволяє клієнтам точно обчислювати затримки в передаванні даних і перевіряти їхню актуальність. Це також спрощує інтеграцію для клієнтів, які вже знайомі з подібними протоколами ринкових даних.

Операційні переваги

Цей потік ідеально підходить для випадків використання, де потрібен негайний доступ до точних цін, зокрема для автоматизованих торгових систем та алгоритмів маркет-мейкінгу. Він дозволяє клієнтам підтримувати актуальне уявлення про ринкову ситуацію, виявляти зміни спреду та здійснювати торги на основі поточних даних.

Однією з ключових переваг потоку є наднизька затримка: оновлення передаються відразу після реєстрації внутрішніх змін у системі. Це гарантує, що клієнти працюють із максимально свіжою інформацією. Потік також спрощує розрахунок спреду та дозволяє ефективно відстежувати рівень ліквідності на верхніх позиціях книги ордерів. Завдяки відкритому відображенню як часу оновлення даних, так і часу відправлення повідомлень, система забезпечує повноцінний моніторинг мережевих затримок і вікна ринкової реакції.

Інтеграція та структура повідомлень

Клієнти можуть підключитися до WebSocket-ендпоінта та підписатися на оновлення для вибраних торгових пар. Кожне повідомлення передається у форматі JSON і містить чітко визначені поля для символу, цін купівлі та продажу, відповідних обсягів, а також дві мітки часу. Формат повідомлення навмисно зроблено легким для підтримки середовищ з високим навантаженням і зменшення складності обробки на стороні клієнта.

Потік WebSocket із найкращими цінами Bid/Ask є важливою складовою інфраструктури для торгівлі в реальному часі. Він надає миттєвий доступ до найконкурентніших ринкових цін з точною інформацією про час, що дає змогу приймати швидкі, обґрунтовані та автоматизовані торгові рішення. Цей потік є надійною основою для будь-якої стратегії, що базується на даних верхнього рівня книги ордерів.

Які питання виникають найчастіше?

Що станеться з API і Webhook ключами в разі вимкнення двофакторної аутентифікації 2FA?

• У разі вимкнення 2FA, ваші API і Webhook ключі буде вимкнено, і активувати їх можна буде знову тільки після ввімкнення 2FA.

Чи можливо створювати й активувати API та Webhook ключі через мобільний додаток WhiteBIT?

• На жаль, ні. Процес створення та активації ключів доступний тільки у вебверсії нашої біржі.

Чи є у ключів API термін дії і яку їх кількість можна створити?

• Якщо ключ API залишається неактивним протягом 14 днів, його буде автоматично деактивовано з метою підтримання безпеки. Максимальна доступна кількість становить 50 ключів.

Чи можна використовувати довільний домен для тестування роботи ключів Webhook?

• Наша система не передбачає таких дій. Для активації ключа Webhook необхідно підтвердити право власності на домен.

Можливі помилки при використанні API

This action is unauthorized. Enable your key in API settings.

Якщо ви зіткнулися з цією помилкою, перевірте, чи увімкнули ви свій ключ API. Щоб активувати його, перемістіть повзунок «Доступ до кінцевої точки» поруч із потрібною кінцевою точкою.

Якщо ви раніше встановили обмеження IP-адреси, ваш ключ API може бути деактивований при використанні з нової IP-адреси. Відповідний лист буде надіслано на вашу електронну адресу.

Зверніть увагу: якщо ви впевнені, що використовували ключ API зі своєї IP-адреси, то можете додати її до списку довірених IP-адрес. Якщо ви не знаєте цю IP-адресу, вам потрібно створити новий ключ API.

You don't have permission to use this endpoint. Please contact support for more details.

Кінцева точка, яку ви використали, доступна тільки для B2B-клієнтів.

Too many requests.

Якщо тіло вашого запиту не містить параметра «nonceWindow», додайте його. У випадку, коли помилка не зникає після додавання цього параметру, вам потрібно буде створити новий ключ API.

Якщо параметр «nonceWindow» вже використовується в тілі вашого запиту, переконайтеся, що значення вказані в мілісекундах.

The selected ticker is invalid.

Введений вами тикер криптовалюти недійсний. Будь ласка, перевірте правильність написання тикера.

Currency is not depositable/withdrawable.

Депозити/виведення вказаної вами криптовалюти наразі закриті. Новини щодо доступності депозитів/виведень криптовалют публікуються в нашому Telegram-каналі.

Підтримка

У разі виникнення будь-яких питань, пов'язаних із функціоналом нашої біржі, ви можете:

• Залишити запит на нашому сайті;
• Написати на електронну пошту служби підтримки: support@whitebit.com;
• Написати в чат, скориставшись кнопкою в правому нижньому кутку екрана (у застосунку WhiteBIT у правому верхньому кутку натисніть ).