Поширені запитання щодо OKX API
Що означає Парафраза?
Це пароль, який ви вказали під час подання заявки на 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-адреси або конкретних дозволів, не матимуть терміну дії.
Що таке дозволи позики, заробітку та переказу?
Переказувати: Дозволяє ключу переказувати кошти між вашими акаунтами. Доступно для всіх акаунтів.
Позика: Дозволяє ключу позичати, погашати та керувати позиками. Відображається лише за наявності у вашому акаунті необхідної функціональної можливості.
Заробляйте: Дозволяє ключу підписуватися на продукти Earn і викупати їх. Відображається лише за наявності у вашому акаунті необхідної можливості.
Якщо ваш API Key раніше мав увімкнені дозволи на Торгівлю, усі три дозволи будуть автоматично активовані після цього оновлення. Ручне налаштування не потрібне.
Чи можна розміщувати ордери у валютних одиницях при розміщенні ордерів через інтерфейс?
Ні; для ордерів на контракти інтерфейс за замовчуванням показує ордери у кількості контрактів. Якщо вам потрібно розрахувати конвертацію між кількістю контрактів і монет, ви можете звернутися до інтерфейсу конвертації контрактів у монети тут.
Як отримати коефіцієнт коливання інтерфейсу?
Інтерфейс не може безпосередньо отримати збільшення або зменшення ціни, але це можна обчислити за допомогою формули.
Зростання або падіння вартості останньої ціни транзакції порівняно з ціною відкриття 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.
Що означає «Помилка інтерфейсу: 51010 Запит не підтримується в поточному режимі акаунта»?
Це пов’язано з вашим режимом акаунта. Якщо ви хочете відкрити позицію з кредитним плечем або контрактом в одній валюті, потрібно переключитися на один із трьох інших режимів, окрім режиму споту! Ви можете налаштувати це через інтерфейс у розділі налаштувань тут, або зробити це на вебсайті чи у застосунку.
Примітка: перше налаштування потрібно встановити на сторінці або в застосунку; опція налаштувань у головному меню сторінки торгівлі - режим акаунта.
Що означає «Помилка інтерфейсу: 51121 Кількість ордера має бути кратною розміру лоту»?
В API ордери на контракти вимірюються в одиницях штук і повинні бути кратними мінімальній кількості ордера для пари валют. Мінімальну кількість ордера можна отримати через поле minSz у інтерфейсі продукту тут.
"Помилка зняття коштів: 58207 Адреса виведення не внесена до білого списку для звільнення від верифікації"; чому верифікація білого списку все ще показує помилку, коли вона вимкнена на сторінці зняття коштів?
Щоб здійснити зняття монет через API-інтерфейс, необхідно додати адресу виведення на сторінці та встановити прапорець «не перевірено Visa». Вимкнення верифікації білого списку на сторінці не вплине на функціональність інтерфейсу.
Що означає «Помилка інтерфейсу: 50004 — тайм-аут запиту до кінцевої точки API» (це не означає, що запит був успішним або неуспішним, будь ласка, перевірте результат запиту)?
Код 50004 зазвичай спричинений надмірним навантаженням на сервер. Щодня збір комісій за капітал відбувається о 8, 16 та 24 годині. У цей час навантаження на сервер високе. Рекомендується розподіляти транзакції у ці часові проміжки. Якщо помилка 50004 виникає в інший час, спробуйте повторити пізніше. Якщо ордер було створено з помилкою 50004, це не відображає фактичний результат запиту інтерфейсу. Запит може бути успішним або неуспішним. Будь ласка, орієнтуйтеся на фактичний результат.
Що означає помилка «50119 API key не існує»?
Ця помилка зазвичай виникає, коли домен вашого акаунта не відповідає вашому регіону.
Для користувачів EEA змініть, будь ласка, доменне ім'я вашого API-запиту на eea.okx.com замість www.okx.com.
Для користувачів зі США змініть, будь ласка, доменне ім'я вашого API-запиту на us.okx.com замість www.okx.com.
Якщо ви використовуєте стороннє програмне забезпечення для підключення до OKX і бачите цю помилку, будь ласка, перевірте у постачальника програмного забезпечення, чи підтримує воно регіональні домени. Наприклад, користувачі з EEA повинні підключатися через 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 у кожен запит із симульованою торгівлею. Ключ із лише дозволом на читання може отримувати дані акаунта, але не може розміщувати ордери.
Що робити, якщо ордер на демо-спот повертає HTTP 503 і код помилки OKX 50001?
Код помилки 50001 із HTTP 503 означає, що сервіс тимчасово недоступний. Будь ласка, спробуйте пізніше. Якщо помилка повторюється, приєднуйтеся до нашої групи підтримки API, щоб зв’язатися з API CS.
Примітка:
Якщо у вас є питання щодо WebSocket або інших тем, пов’язаних з API, натисніть на посилання статті та відскануйте QR-код у нижній частині статті за допомогою застосунку OKX, щоб приєднатися до групи та звернутися до нашого спеціаліста з підтримки API.
Як сканувати: у застосунку натисніть Меню > іконку Сканування та відскануйте QR-код.