Вопросы и ответы по OKX API
Что означает термин «Passphrase»?
Это пароль, который вы указали при создании API-ключа. Вам нужно запомнить его самостоятельно. Если вы забудете пароль, его нельзя будет восстановить, и вам придётся создать новый API-ключ.
Как создать API-ключ?
В приложении:
1. Войдите в свой аккаунт OKX > Выберите Меню (⋮⋮⋮) > Прокрутите вниз и выберите API > Создать API-ключ
2. Заполните название API > Выберите аккаунт и назначение > Введите белый список IP-адресов > Выберите разрешения > Введите секретную фразу
Веб-версия:
1. Войдите в свой аккаунт OKX > Перейдите в Профиль и выберите API и подключения > Создать API-ключ
2. Заполните название API-ключа > Выберите аккаунт и назначение
3. Введите белый список IP-адресов > выберите Разрешения > введите Парольную фразу
Примечание:
IP-адреса помогают защитить ваш API-ключ. Вы можете привязать до 20 адресов к одному ключу, разделяя их запятой или пробелом.
Для просмотра информации об API и доступа к его интерфейсу требуется авторизация. Пожалуйста, храните свой пароль в безопасности. Если вы потеряете пароль, вы можете создать новый API, так как мы не можем восстановить существующие API.
Как управлять или редактировать API-ключ?
Чтобы управлять или редактировать ваш API-ключ на OKX:
Войдите в свой аккаунт OKX и перейдите в Профиль > API.
Вы увидите список ваших существующих API-ключей. Нажмите на тот, которым хотите управлять.
Отсюда вы можете:
Просмотреть имя API-ключа, разрешения и связанный белый список IP-адресов.
Измените имя ключа, разрешения (Чтение, Торговля, вывести средства) или привязанные IP-адреса.
Удалите ключ, если он больше не нужен.
Примечание: Вы не сможете просмотреть парольную фразу после её первоначального создания. Если вы её потеряете, потребуется удалить существующий ключ и создать новый. Всегда храните свои данные для входа в безопасности.
Как мне отличить спотовую торговлю от маржинальной, если я торгую через API?
Способ различения спотовой и маржинальной торговли через API может варьироваться в зависимости от типа вашего аккаунта и настроек. Рекомендуем обратиться к документации OKX API для получения наиболее точных и актуальных параметров, применимых к вашей конфигурации аккаунта.
Если вам нужна дополнительная информация, пожалуйста, обратитесь к Ассистенту OKX за персональной помощью.
Как создать демонстрационный API-ключ для диска?
Чтобы совершать сделки через API демо-диска, необходимо создать API-ключ на демо-диске. Следуйте приведённым ниже шагам:
Войдите в аккаунт OKX > Торговля > Демо-торговля > Личный кабинет > Создать API-ключ демо-аккаунта > Начать демо-торговлю
Истекает ли срок действия API-ключа?
API-ключи, не привязанные к IP и имеющие разрешения на транзакции или вывод средств, будут автоматически удалены после 14 дней бездействия. API-ключи не будут считаться неактивными, если они используются для вызова приватных или связанных с аккаунтом интерфейсов, требующих Верификации личности, таких как просмотр баланса аккаунта, данных по выставленным счетам или размещение ордеров.
Только API-ключи с правами только для чтения, привязанные к IP-адресу или определённым разрешениям, не истекают.
Что означают разрешения на Займы, Заработок и перевод?
Перевод: Позволяет ключу осуществлять перевод средств между вашими аккаунтами. Доступно для всех аккаунтов.
Займы: Позволяет ключу заимствовать, погашать и управлять займами. Видно только если ваш аккаунт имеет необходимую возможность.
Зарабатывать: Позволяет ключу подписываться на продукты Зарабатывать и выводить их. Видно только если ваш аккаунт соответствует требованиям для этой функции.
Если у вашего API-ключа ранее были включены разрешения на Торговлю, все три разрешения будут автоматически активированы после этого обновления. Ручная настройка не требуется.
Можно ли размещать ордера в единицах валюты при размещении ордеров через интерфейс?
Нет; для ордеров на контракты интерфейс по умолчанию показывает количество контрактов. Если вам нужно рассчитать конвертацию между количеством контрактов и монет, вы можете обратиться к интерфейсу конвертации контрактов в монеты здесь.
Как получить коэффициент колебаний интерфейса?
Интерфейс не может напрямую получить увеличение или уменьшение цены, но это можно вычислить с помощью формулы расчёта.
Значение роста и падения последней цены транзакции по сравнению с ценой открытия K-линии 24 часа назад / 100 % от цены открытия K-линии 24 часа назад.
Данные по приведённой формуле можно получить через рыночный интерфейс здесь.
В чём причина ошибки с сообщением «51000 Parameter posSide error» при размещении ордера?
Сначала необходимо проверить режим аккаунта: режим покупки и продажи/режим открытия и закрытия, который можно посмотреть здесь, чтобы получить posMode.
Примечание:
В случае открытия и закрытия позиций и размещения ордеров с использованием контракта требуется параметр posSide, в который указывается лонг или шорт.
Если это режим покупки и продажи, или криптовалютная или маржинальная транзакция проводится в режиме открытия и закрытия, posSide поддерживает только net или отсутствие передачи.
Какой интерфейс можно использовать для получения номинальной стоимости контракта и минимального количества ордера?
Вы можете использовать интерфейс, чтобы получить основную информацию о торговых продуктах здесь.
номинальная стоимость контракта: ctVal, минимальное количество ордера: minSz.
Каков формат instId?
Вы можете напрямую использовать интерфейс, чтобы получить основную информацию о торговых продуктах здесь.
Как установить ордер стоп-лосс и тейк-профит?
Если ордер привязан к тейк-профиту или ордеру стоп-лосс, вы можете ознакомиться с интерфейсом ордера здесь: параметры массива attachAlgoOrds.
Однако, если это отдельный ордер стоп-лосс, вы можете ознакомиться с интерфейсом комиссионных по стратегии здесь.
Почему при установке триггерной цены для тейк-профита и ордера стоп-лосс возникает ошибка: 51046, 51047, 51048, 51049?
Правила установки триггерной цены стоп-лосс/триггерной цены тейк-профит: при продаже триггерная цена тейк-профит должна быть выше последней цены транзакции, а триггерная цена стоп-лосс — ниже последней цены транзакции; при покупке триггерная цена тейк-профит должна быть ниже последней цены транзакции, а триггерная цена стоп-лосс — выше последней цены транзакции.
Что означает «Ошибка интерфейса: 50102 Запрос временной метки истёк»?
Эта ошибка возникает, когда метка времени истекла. Вам необходимо вызвать интерфейс системного времени, чтобы синхронизировать ваше локальное время с временем нашего сервера. Поддержание разницы во времени в пределах 30 секунд поможет избежать этой проблемы.
Примечание: время в заголовке запроса указано в UTC0. При вызове интерфейса серверного времени время предоставляется в UTC + 8.
Что означает «Ошибка интерфейса: 50101 APIKey не соответствует текущей среде»?
Это связано с несоответствием между API-ключом и текущей средой. Вызовы с реального аккаунта требуют использования API-ключа реального аккаунта, а значение параметра x-simulated-trading в заголовке запроса должно быть 0. Вызовы с симулированного аккаунта требуют использования API-ключа симулированного аккаунта, а значение параметра x-simulated-trading в заголовке запроса должно быть 1.
Что означает «Interface error: 51010 Request unsupported under current account mode»?
Это связано с вашим режимом аккаунта. Если вы хотите открыть позицию с торговым плечом или контрактом в одной валюте, вам нужно переключиться на один из трёх других режимов, кроме спотового режима! Вы можете настроить это через настройки интерфейса здесь, либо на веб-сайте или в приложении.
Примечание: первый параметр необходимо установить на странице или в приложении; опция настроек в главном меню страницы торговли — режим аккаунта.
Что означает «Ошибка интерфейса: 51121 Количество ордера должно быть кратно размеру лота»?
В API ордера на контракты измеряются в листах и должны быть кратны минимальному количеству ордера для валютной пары. Минимальное количество ордера можно узнать через поле minSz в интерфейсе продукта здесь.
«Ошибка вывода средств: 58207 Адрес вывода средств не находится в белом списке для освобождения от верификации»; почему проверка белого списка все еще выдает ошибку, если она отключена на странице вывода средств?
Чтобы вывести монеты через API-интерфейс, необходимо добавить адрес вывода средств на странице и снять отметку с кнопки «не подтверждено Visa». Отключение верификации белого списка на странице не повлияет на работу интерфейса.
Что означает «Ошибка интерфейса: 50004 — тайм-аут запроса к серверу API» (это не значит, что запрос был успешным или неудачным, пожалуйста, проверьте результат запроса)?
Ошибка 50004 обычно вызвана чрезмерной нагрузкой на сервер. В 8, 16 и 24 часа ежедневно происходит сбор комиссий за капитал. В это время нагрузка на сервер высокая. Рекомендуется распределять транзакции во времени, чтобы избежать пиковых нагрузок. Если ошибка 50004 возникает в другое время, можно повторить попытку позже. Если ордер был размещён с ошибкой 50004, это не отражает фактический результат запроса к интерфейсу. Запрос мог выполниться успешно или завершиться неудачей. Пожалуйста, ориентируйтесь на фактический результат.
Что означает ошибка «50119 API key doesn’t exist»?
Эта ошибка обычно возникает, когда домен вашего аккаунта не соответствует вашему региону.
Для пользователей из ЕЭЗ измените, пожалуйста, домен в вашем API-запросе на eea.okx.com вместо www.okx.com.
Для пользователей из США измените, пожалуйста, домен в вашем API-запросе на us.okx.com вместо www.okx.com.
Если вы используете стороннее программное обеспечение для подключения к OKX и видите эту ошибку, пожалуйста, уточните у поставщика программного обеспечения, поддерживает ли оно региональные домены. Например, пользователи из ЕЭЗ должны подключаться через eea.okx.com, иначе запрос не будет выполнен.
Почему при привязке к стороннему программному обеспечению появляется ошибка «50110»?
Эта ошибка может возникать, если текущий тип API-ключа несовместим с привязкой стороннего программного обеспечения. Попробуйте запросить API-ключ типа «транзакция» без привязки списка IP-адресов, а затем повторно подключить стороннее программное обеспечение.
Как получить последнюю цену транзакции определённой валютной пары?
Используйте сведения здесь для тикеров и для тикера — здесь. Интерфейс тикеров используется для получения последних цен транзакций по валютным парам пакетно, а тикер — для получения последних цен транзакций по отдельным валютным парам.
Пример параметра ответа цены последней сделки в разделе тикеров
Каковы требования для создания API-ключа?
Для создания API-ключа требуется минимальный баланс активов под управлением (AUM) в размере 100 USD.
Для создания API-ключа требуется AUM больше 100 USD (AUM > 100U)
Для главных аккаунтов или субаккаунтов создавать API-ключи разрешено только аккаунтам с AUM > 100U
Примечание: Это требование применимо только к пользователям в определённых регионах
Что делать, если WebSocket не может подключиться или постоянно отключается?
Подтвердите, что вы используете правильный URL WebSocket для вашего сайта и API-сервиса. Проверьте настройки блокчейна, прокси, TLS, параметры подписки, Ping/Pong heartbeat и логику переподключения. Если проблема сохраняется, предоставьте канал, время возникновения, полное сообщение об ошибке и скрытые логи.
Как мне устранить ошибку API с кодом или неверным параметром запроса?
Найдите код ошибки в официальной документации API для вашего сайта, затем проверьте сервер, HTTP-метод, параметры запроса, режим аккаунта и ограничения продукта. Если причина по-прежнему не ясна, предоставьте полный код ошибки, sCode/sMsg, время возникновения и скрытые запрос и ответ.
Почему не удалось разместить, изменить или отменить мой ордер через API?
Пожалуйста, используйте сообщение об ошибке и код ошибки, возвращённые API, чтобы определить конкретную причину. Если вы не уверены, что означает ошибка, предоставьте полные параметры запроса и сведения об ошибке, чтобы мы могли провести дальнейшее расследование.
Что делать, если рыночные данные, свечи или данные книги ордеров выглядят некорректно?
Подтвердите название канала, instId, параметры подписки и частоту запросов, а также различайте снимки данных и инкрементальные обновления. Для книги ордеров дополнительно проверьте идентификаторы последовательности и временные метки. Если данные отсутствуют, зафиксируйте канал, временной диапазон и отредактированный исходный ответ.
Почему балансы API, позиции или значения маржи отличаются от данных на сайте или в приложении?
Сначала различите торговый аккаунт и основной аккаунт, затем пройдите верификацию режима аккаунта, валютного измерения, сервера и времени обновления данных. Для расчётов баланса, позиции и маржи используйте последнюю документацию по продукту и API для соответствующего сайта.
Что делать, если не удалось выполнить внесение депозита, вывод средств или перевод через API?
Проверьте разрешения API, валюту, блокчейн, целевой аккаунт, а также требования к адресной книге или белому списку, затем устраните неполадки, используя возвращённый код ошибки. Ограничения по безопасности аккаунта, соответствию нормативным требованиям или рискам могут потребовать дополнительного рассмотрения службой поддержки соответствующего сайта.
Как создать и использовать API-ключ для субаккаунта?
Создайте API-ключ в нужном субаккаунте и используйте разрешения, пароль и домен сайта этого субаккаунта. Не смешивайте API-ключ, секрет или пароль родительского аккаунта и субаккаунта.
Что мне делать после срабатывания ограничения скорости API?
Снизьте частоту запросов в соответствии с лимитом для конкретного сервера и используйте очереди запросов, экспоненциальное увеличение интервала повторных попыток или пакетные серверы, когда это уместно. Область действия и квота ограничения скорости могут различаться в зависимости от сервера, поэтому не предполагайте, что все серверы имеют одинаковое разрешение.
Где я могу найти документацию по API, SDK и примеры кода?
Вы можете ознакомиться с документацией API (V5). Справочник по REST и WebSocket, журнал изменений, коды ошибок, примеры запросов и ответов для каждого сервера. Официальные SDK (GitHub) — github.com/okxapi Пример кода можно найти в SDK.
Какую информацию мне следует предоставить, если я могу сказать только «API не работает»?
Укажите сервер, HTTP-метод, предполагаемую операцию, полный код ошибки или сообщение, время возникновения, сайт аккаунта, блокчейн-среду, а также скрытые запрос и ответ. Никогда не отправляйте API Secret, Passphrase, код верификации или незащищённую подпись.
Что мне делать, если у меня остались вопросы по API? Или могу ли я связаться с поддержкой API в чате?
Если у вас есть дополнительные вопросы, вы можете присоединиться к нашей группе поддержки API:
Что мне делать, если API Демо-торговли возвращает код ошибки 50123?
Код ошибки 50123 означает, что API-ключ не имеет разрешения на сделку с криптовалютой. Для Демо-торговли используйте API-ключ, созданный в разделе Демо-торговля, убедитесь, что ключ имеет разрешение на сделку, используйте правильный API-домен для вашего сайта и включите x-simulated-trading: 1 в каждом запросе simulated-trading. Ключ с разрешением только на чтение может получать данные аккаунта, но не может размещать ордера.
Что мне делать, если ордер на демонстрационной спотовой торговле возвращает HTTP 503 и код ошибки OKX 50001?
Код ошибки 50001 с HTTP 503 означает, что сервис временно недоступен. Пожалуйста, попробуйте позже. Если ошибка сохраняется, присоединяйтесь к нашей группе поддержки API для связи с API CS.
Примечание:
Если у вас есть вопросы по WebSocket или другим темам, связанным с API, перейдите по ссылке на статью и отсканируйте QR-код внизу статьи с помощью приложения OKX, чтобы присоединиться к группе и связаться с нашим специалистом по поддержке API.
Как сканировать: в приложении нажмите Меню > значок Сканировать и отсканируйте QR-код.