Що таке API WEEX? Можливості, інструменти для торгівлі та принцип роботи

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

API підтримує спотову торгівлю та торгівлю ф'ючерсами USDT-M, а також надає доступ через REST API і WebSocket. Розробники можуть отримувати ціни, дані свічок, глибину книги ордерів і дані про угоди в реальному часі, а автентифіковані інтерфейси підтримують операції з обліковим записом і торгівлю. 

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

Що таке API WEEX?

API WEEX — це технічний інтерфейс, який дає змогу зовнішнім застосункам взаємодіяти з підтримуваними функціями біржі WEEX.

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

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

Наразі API охоплює спотову торгівлю та торгівлю ф'ючерсами USDT-M. WEEX підтримує окрему документацію для різних продуктів API, а на сторінках ендпоінтів наведено параметри запитів і приклади відповідей для розробників. 

Що можна робити за допомогою API WEEX?

API WEEX можна використовувати як для моніторингу ринку, так і для торгових операцій.

Для отримання ринкових даних WEEX надає доступ до інформації, зокрема цін за 24 години, змін цін, обсягів торгів, даних свічок, глибини книги ордерів і угод у реальному часі. Ці потоки даних можна використовувати в застосунках для моніторингу ринків або передавати як вхідні дані торговим системам. 

Для торгівлі автентифіковані інтерфейси API дають користувачам змогу програмно виконувати підтримувані операції. Дозволи для спотового API можуть надавати застосункам змогу розміщувати та скасовувати спотові ордери, а дозвіл Futures підтримує операції з ф'ючерсами, як-от відкриття та закриття позицій, а також встановлення тейк-профіту та стоп-лосу.

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

Саму торгову стратегію API не надає. API забезпечує зв'язок між застосунком користувача та підтримуваними функціями WEEX, тоді як користувач визначає правила й логіку зовнішньої системи.

Які основні функції API WEEX?

Одна з основних функцій API WEEX — підтримка підключень через REST API і WebSocket.

REST API підходить для запитів конкретної інформації або надсилання окремих підтримуваних команд. WebSocket підтримує активне з'єднання та може безперервно отримувати оновлену інформацію, тому він корисний для отримання ринкових даних і оновлень книги ордерів. У документації WEEX для отримання ринкової інформації, що часто змінюється, рекомендовано використовувати WebSocket.

API WEEX також охоплює спотову торгівлю та торгівлю ф'ючерсами USDT-M. Тож розробники можуть працювати з підтримуваними ринковими даними й торговими функціями в обох категоріях продуктів за допомогою відповідних ресурсів API.

Ще одна важлива функція — доступ до різних типів ринкових даних. Розробники можуть отримувати дані свічок для аналізу цін, відстежувати глибину заявок на купівлю та продаж у книзі ордерів, стежити за нещодавніми угодами та отримувати актуальну ринкову інформацію.

Для користувачів ф'ючерсів WEEX також надає офіційні ендпоінти Paper Trading. Ці інтерфейси підтримують симульовані баланси рахунку, позиції, розміщення ордерів та історію ордерів, що дає розробникам змогу тестувати підтримувані торгові процеси без використання реальних активів.

Як працюють API-ключі та дозволи WEEX?

Для доступу до приватних функцій API потрібна автентифікація за допомогою API Key. Згідно з поточною документацією WEEX Spot V3, для щойно створеного API Key за замовчуванням встановлено дозвіл Read Only. Він надає доступ до запитів, але не дає змоги торгувати на спотовому ринку. Щоб застосунок міг розміщувати або скасовувати спотові ордери, користувачам потрібно ввімкнути відповідний дозвіл Spot.

У WEEX Futures використовується схожа система дозволів. Доступ Readonly можна використовувати для запитів, наприклад про баланси, позиції та історію торгівлі, а дозвіл Futures дає змогу виконувати підтримувані операції з ф'ючерсами, зокрема відкривати й закривати позиції та встановлювати TP/SL.

Під час створення API Key користувачі отримують або налаштовують три важливі облікові дані: APIKey, SecretKey і Passphrase. WEEX попереджає користувачів про необхідність захищати ці облікові дані та видалити API Key, якщо його буде скомпрометовано.

WEEX також підтримує прив'язку API Key до IP-адреси та рекомендує використовувати білий список IP-адрес для підвищення безпеки.

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

Чи можна протестувати API WEEX до використання реальних активів?

Наразі WEEX надає інтерфейси Paper Trading для свого Futures API. Ці ендпоінти призначені для налагодження стратегій і тестування торгових процесів без використання реальних активів.

В офіційній документації Futures API наведено симульовані ендпоінти для перевірки балансів рахунку, перегляду позицій, розміщення ордерів і перевірки історії ордерів. Серед підтримуваних симульованих ордерів — ринкові та лімітні.

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

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

Які ліміти швидкості запитів API WEEX?

WEEX встановлює ліміти швидкості запитів до API, щоб підтримувати стабільність системи. Застосовний ліміт залежить від продукту API та операції, що використовується.

Для поточного Spot V3 API в офіційному розділі поширених запитань зазначено ліміт спотових ордерів у 100 ордерів за 10 секунд. Скасування спотових ордерів обмежене 80 разами за 10 секунд або 200 разами за хвилину, тоді як ліміт ваги запитів для мережевої IP-адреси становить 500 за 10 секунд на IP-адресу. 

Для Futures API у поточному офіційному розділі поширених запитань зазначено ліміт розміщення ордерів — 300 разів на хвилину, ліміт REST — 500 одиниць ваги за 10 секунд на IP-адресу та максимум 20 підключень WebSocket на IP-адресу.

Якщо REST-запит перевищує застосовний ліміт швидкості, WEEX може повернути кодHTTP 429. Тому під час проєктування торгової системи на основі API розробникам слід враховувати відповідні ліміти.

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

Для кого призначений API WEEX?

API WEEX можуть використовувати розробники та кількісні трейдери, яким потрібен програмний доступ до підтримуваних функцій біржі.

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

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

Доступні інструменти підтримують і різні рівні використання API. Дозволи Readonly можна використовувати для моніторингу й аналізу, а торгові дозволи надають доступ до підтримуваних функцій роботи з ордерами. Futures Paper Trading додатково пропонує середовище для тестування робочих процесів API до використання реальних активів.

Висновок

API WEEX з'єднує зовнішні застосунки й торгові системи з підтримуваними функціями біржі WEEX. Він надає доступ через REST API і WebSocket, підтримує спотову торгівлю та торгівлю ф'ючерсами USDT-M, ринкові дані, автентифіковані торгові операції, налаштовувані дозволи та інтерфейси Paper Trading для ф'ючерсів.

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

Поширені запитання

1. Що таке API WEEX?
API WEEX — це набір програмних інтерфейсів, який дає розробникам і кількісним трейдерам змогу підключати зовнішні застосунки до підтримуваних функцій WEEX для отримання ринкових даних і торгівлі. Він надає доступ через REST і WebSocket.

2. Які торгові продукти підтримує API WEEX?
WEEX надає ресурси API для спотової торгівлі та ф'ючерсів USDT-M. Доступні функції залежать від продукту API, ендпоінта та дозволів.

3. Чи можна використовувати API WEEX для автоматизованої торгівлі?
Так. Автентифіковані інтерфейси API WEEX підтримують програмну торгівлю, тож користувачі можуть створювати системи, які надсилають підтримувані торгові команди відповідно до власної логіки.

4. Чи підтримує API WEEX паперову торгівлю?
Так. WEEX надає ендпоінти Paper Trading для свого Futures API із симульованими балансами, позиціями, розміщенням ордерів і функціями перегляду історії ордерів.

5. Чи має API WEEX ліміти швидкості запитів?
Так. Ліміти швидкості запитів залежать від API та операції й можуть змінюватися з часом. Перед розробкою системи розробникам слід перевірити актуальну офіційну документацію.