REST API
Публічні кінцеві точки
| Кінцева точка | Метод | Шлях | Опис |
|---|---|---|---|
| Сервісна версія | GET | /v1/version | Отримати інформацію про версію сервісу |
| Час сервера | GET | /v1/time | Отримуйте серверний час |
| Вхід користувача | POST | /v1/public/user/login | Використовуйте ім’я користувача та пароль для отримання accessToken |
| Токен оновлення | POST | /v1/public/user/refresh-token | Оновити стан входу через Cookie |
| Обмін квитків агента | POST | /v1/public/agent-sso/exchange-ticket | Обміняйте вхідний квиток агента на стан входу |
| Обмін токенами вбудовування агента | POST | /v1/public/agent-sso/exchange-embed-token | Обміняйте вбудований токен для короткоживучої торгівлі на стан входу |
| Конфігурація символів | GET | /v1/public/market/symbols | Отримайте символи, торгові правила та конфігурацію тарифних рівнів |
| Конфігурація ставки фінансування | GET | /v1/public/market/funding-rate | Конфігурація ставки фінансування запиту |
| Поточний рівень фінансування | GET | /v1/public/market/funding-rate/current | Сторінкуйте поточні ставки фінансування |
| Історія ставок фінансування | GET | /v1/public/market/funding-rate/history | Історія ставки фінансування запиту |
| Клайнс | GET | /v1/public/market/klines | Запитуйте ціну торгівлі, ціну індексу або ціну марки Клайнс |
| Таблиця лідерів PnL | GET | /v1/public/leaderboard/pnl | Запит 7 / 30 / 90 днів PnL лідерборд |
Приватні кінцеві точки користувача
Якщо не вказано інше, наступні кінцеві точки можуть використовувати JWT або API Key підписи.
| Кінцева точка | Метод | Шлях | Дозвіл | Опис |
|---|---|---|---|---|
| Інформація про користувача | GET | /v1/private/user/info | Читати | Запит на поточний профіль користувача |
| Користувацькі ресурси | GET | /v1/private/user/asset | Читати | Запит щодо балансу гаманця та використання маржі |
| Створіть listenKey | POST | /v1/private/user/listen-key | Читати | Створіть приватний WebSocket ключ автентифікації |
| Оновити listenKey | PUT | /v1/private/user/listen-key | Читати | Розширення listenKey дійсності |
| Close listenKey | DELETE | /v1/private/user/listen-key | Читати | Close listenKey |
| Журнали змін облікових записів | GET | /v1/private/user/account-change-log | Читати | Записи про переміщення фонду запиту |
| Статистика обсягів за 30 днів | GET | /v1/private/user/volume-stats | Читати | Запит щодо останнього обсягу торгівлі за 30 днів та комісій |
| Історія балансу | GET | /v1/private/user/balance-history | Читати | Історія балансу запитів |
| Огляд торгівлі | GET | /v1/private/user/trade-overview | Читати | Запит PnL, обсяг і тренд активів |
| Огляд активів | GET | /v1/private/user/asset/overview/summary | Читати | Метрики резюме активів запиту |
| Тенденція огляду активів | GET | /v1/private/user/asset/overview/trend | Читати | Тренд активів запиту |
| Зберегти улюблені символи | POST | /v1/private/user/favorite-symbols | Читати | Перезаписати улюблені символи |
| Отримайте улюблені символи | GET | /v1/private/user/favorite-symbols | Читати | Запит на улюблені символи |
| Вихід з гри | POST | /v1/private/user/logout | JWT + Cookie | Очистити стан входу |
API Key Кінцеві точки управління
API Key кінцеві точки управління приймають лише JWT.
| Кінцева точка | Метод | Шлях | Опис |
|---|---|---|---|
| Створіть API Key | POST | /v1/private/user/api-key/create | Створіть API Key; apiSecret повертається лише один раз |
| API Key список | GET | /v1/private/user/api-key/list | Запит API ключів поточного користувача |
| Оновлення API Key | PUT | /v1/private/user/api-key/update | Оновити мітку, дозволи, IP білий список і статус |
| Видалити API Key | POST | /v1/private/user/api-key/delete | Видалити вказану API Key |
| Видалити всі API Keys | POST | /v1/private/user/api-key/delete-all | Видалити всі API ключі поточного користувача |
Кінцеві точки порядку
Кінцеві точки замовлення потребують дозволу на торгівлю.
| Кінцева точка | Метод | Шлях | Опис |
|---|---|---|---|
| Запит у однопорядковому порядку | GET | /v1/private/order | Точний запит від symbol + orderId/clientOrderId |
| Оформити замовлення | POST | /v1/private/order/place | Лімітний або ринковий ордер |
| Ордер розташування умов | POST | /v1/private/order/place-condition | Стоп-лосс, тейк-профит, трейлінг-стоп та інші умовні накази |
| Поставити стратегічний ордер | POST | /v1/private/order/place-strategy | OTO / OCO / OTOCO ордер стратегії |
| Замовлення на пакетне розміщення | POST | /v1/private/order/batch-place | Подайте кілька звичайних замовлень |
| Скасувати замовлення | POST | /v1/private/order/cancel | Скасувати заданий нормальний ордер |
| Наказ про внесення змін | POST | /v1/private/order/move | Змініть звичайну ціну та кількість очікуваного ордеру |
| Накази про внесення змін у групу | POST | /v1/private/order/batch-move | Пакетна модифікація звичайних очікуваних замовлень для того ж символу |
| Замовлення на скасування пакетів | POST | /v1/private/order/batch-cancel | Пакетне скасування звичайних замовлень |
| Скасувати все | POST | /v1/private/order/batch-cancel-all | Пакетні замовлення на скасування за типом |
| Ордер скасування умови | POST | /v1/private/order/cancel-condition | Скасувати заданий ордер умов |
| Поточні нормальні порядки | GET | /v1/private/order/current | Запит на поточні нормальні очікування наказів |
| Поточні порядки стану | GET | /v1/private/order/current-condition | Запит на поточні порядки неактивованих умов |
| Історичні нормальні порядки | GET | /v1/private/order/history | Пагінуйте історичні нормальні порядки |
| Історичні порядки стану | GET | /v1/private/order/history-condition | Історичні порядки стану пагінат |
| Торгові рекорди | GET | /v1/private/order/trades | Торгові записи пагінате |
| Деталі порядку стратегії | GET | /v1/private/order/strategy | Ордер і підпорядки стратегії запиту |
Кінцеві точки позицій
Кінцеві точки позиції потребують дозволу на торгівлю.
| Кінцева точка | Метод | Шлях | Опис |
|---|---|---|---|
| Встановити режим поля | POST | /v1/private/position/margin-mode | Перемикач ізольований / крос-марж |
| Важіль встановлення | POST | /v1/private/position/leverage | Важіль символів множин |
| Налаштування позицій | GET | /v1/private/position/settings | Важіль запиту та режим поля для символу |
| Поточні посади | GET | /v1/private/position/positions | Запит на поточні позиції |
| Історія позиції | GET | /v1/private/position/history | Запит історичних позицій та близьких записів |