API Documentation

RESTful API для интеграции с платформой обмена криптовалют. Все запросы используют JSON формат.

Base URL

https://api.exchblack.is/v1

Аутентификация

Для доступа к API требуется API ключ. Передавайте его в заголовке X-API-Key: 

X-API-Key: your_api_key_here

Endpoints

1. Создание заявки

POST /orders

Создает новую заявку на обмен криптовалют.

Параметры запроса:

Параметр Тип Обязательный Описание
from_symbol string Required Символ валюты отправки (BTC, ETH, USDT и т.д.)
to_symbol string Required Символ валюты получения
from_blockchain string Required Блокчейн валюты отправки (bitcoin, ethereum, tron и т.д.)
to_blockchain string Required Блокчейн валюты получения
amount_in string Required Сумма отправки (в формате строки для точности)
recipient string Required Адрес получателя
refund_to string Optional Адрес возврата (если обмен не удастся)

Пример запроса:

POST /v1/orders
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "from_symbol": "BTC",
  "to_symbol": "USDT",
  "from_blockchain": "bitcoin",
  "to_blockchain": "tron",
  "amount_in": "0.01",
  "recipient": "TFbhDKSa3BcKQvn9D3U3QovdaA36yvu7cw",
  "refund_to": "bc1qrl847zj8t49p4r5cw867m24vnaxzshmvv0gjde"
}

Пример ответа:

{
  "success": true,
  "data": {
    "id_order": "A84e3K",
    "deposit_address": "13ix6Yri8ztbscKYRu4RPtJFzxtg6nBQLs",
    "amount_in": "0.01",
    "amount_out": "870.764",
    "from_symbol": "BTC",
    "to_symbol": "USDT",
    "from_blockchain": "bitcoin",
    "to_blockchain": "tron",
    "recipient": "TFbhDKSa3BcKQvn9D3U3QovdaA36yvu7cw",
    "refund_to": "bc1qrl847zj8t49p4r5cw867m24vnaxzshmvv0gjde",
    "status": "PENDING_DEPOSIT",
    "created_at": 1703520000,
    "expires_at": 1703521800
  }
}

2. Получение информации о заявке

GET /orders/{order_id}

Получает информацию о заявке по её ID.

Пример запроса:

GET /v1/orders/A84e3K
X-API-Key: your_api_key_here

3. Получение статуса заявки

GET /orders/{order_id}/status

Получает текущий статус заявки.

Возможные статусы:

  • PENDING_DEPOSIT - ожидание депозита
  • PROCESSING - обработка
  • SUCCESS - успешно завершено
  • FAILED - ошибка
  • REFUNDED - возврат средств

4. Получение курсов обмена

GET /rates

Получает актуальные курсы обмена для доступных пар.

Query параметры:

Параметр Тип Обязательный Описание
from string Optional Фильтр по валюте отправки
to string Optional Фильтр по валюте получения

Коды ошибок

Код Описание
400 Неверный запрос (неверные параметры)
401 Не авторизован (неверный или отсутствующий API ключ)
404 Заявка не найдена
429 Превышен лимит запросов
500 Внутренняя ошибка сервера

Лимиты запросов

По умолчанию: 100 запросов в минуту на один API ключ. При превышении лимита возвращается ошибка 429 Too Many Requests.

Webhooks

Вы можете настроить webhook URL для получения уведомлений об изменении статуса заявок. Webhook будет отправлять POST запросы на указанный URL при каждом изменении статуса.

Настройка webhook:

POST /webhooks

Параметры:

Параметр Тип Описание
url string URL для отправки уведомлений
events array Список событий для отслеживания (order.created, order.updated, order.completed)

Поддержка

Если у вас возникли вопросы по использованию API, обратитесь в поддержку:

  • Telegram: @