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), которое показывает, когда данные о ценах были в последний раз изменены на уровне matching engine (движка сопоставления заявок).
  
  

Такой подход с двойной временной меткой позволяет клиентам точно вычислять задержки при передаче данных и проверять их актуальность. Это также упрощает интеграцию для клиентов, которые уже знакомы с аналогичными протоколами рыночных данных.

Операционные преимущества

Этот поток идеально подходит для сценариев, где требуется немедленный доступ к точным ценам, включая автоматизированные торговые системы и алгоритмы маркет-мейкинга. Он позволяет клиентам поддерживать актуальное представление о рыночной ситуации, выявлять изменения спреда и совершать сделки на основе текущих данных.

Одним из ключевых преимуществ потока является сверхнизкая задержка: обновления передаются сразу после регистрации внутренних изменений в системе. Это гарантирует, что клиенты работают с максимально свежей информацией. Поток также упрощает расчет спреда и позволяет эффективно отслеживать уровень ликвидности на верхних уровнях книги ордеров. Благодаря открытому отображению как времени обновления данных, так и времени отправки сообщений, система обеспечивает полноценный мониторинг сетевых задержек и временных окон рыночной реакции.

Интеграция и структура сообщений

Клиенты могут подключиться к 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 в правом верхнем углу нажмите ).