ДОКУМЕНТАЦИЯ ДЛЯ РАЗРАБОТЧИКОВ

Ваш майнинг.
Ваши интеграции.

Получайте статистику пула, следите за оборудованием и учитывайте начисления через клиентский REST API RuPool.

https://api.rupool.pro/v1/api

Быстрый старт

  1. Войдите в кабинет RuPool и откройте Настройки → API.
  2. Создайте API-ключ с нужными правами. Сохраните ключ и секрет при создании: секрет показывается один раз.
  3. Передайте оба значения в заголовках запроса. Для примера ниже нужно право read_stats.
export RUPOOL_API_KEY='ваш-ключ'
export RUPOOL_API_SECRET='ваш-секрет'

curl --fail-with-body 'https://api.rupool.pro/v1/api/mining/summary' \
  -H "X-RuPool-API-Key: $RUPOOL_API_KEY" \
  -H "X-RuPool-API-Secret: $RUPOOL_API_SECRET"

Используйте API с вашего сервера. Храните секрет в переменных окружения или менеджере секретов; не добавляйте его в браузерный код и публичные репозитории.

Пример на Python (стандартная библиотека)
import json
import os
import urllib.request

request = urllib.request.Request(
    'https://api.rupool.pro/v1/api/workers?coin=btc',
    headers={
        'X-RuPool-API-Key': os.environ['RUPOOL_API_KEY'],
        'X-RuPool-API-Secret': os.environ['RUPOOL_API_SECRET'],
    },
)
with urllib.request.urlopen(request, timeout=30) as response:
    workers = json.load(response)['data']
    print(workers)

Авторизация и права

Каждый запрос требует X-RuPool-API-Key и X-RuPool-API-Secret. HMAC-подпись и JWT для этих методов не требуются. У ключа проверяются активность, срок действия и разрешённый IP, если задан список IP.

ПравоДоступ
read_statsСводка майнинга, воркеры, история хешрейта и начисления
read_payoutsВыплаты и транзакции
manage_subaccountsЧтение, создание, редактирование и удаление субаккаунтов; чтение кошельков
manage_workersПрофили оборудования и чтение данных воркеров
manage_settingsНастройки пользователя и расходы

Старые права read и write разрешают соответственно чтение и запись в доступных внешнему API разделах. Для новых интеграций выбирайте конкретные права из таблицы.

Изменение адреса и настроек выплат, передача субаккаунта, управление API-ключами и вебхуками выполняются в кабинете. Эти операции не входят в клиентский API.

Форматы и ошибки

Тела запросов и ответы — JSON. Для POST и PUT передавайте Content-Type: application/json. В путях {id} — числовой ID, а {subaccount} и {worker} — имена. Кодируйте значения сегментов URL.

Хешрейт передаётся в H/s. Денежные суммы — в монете записи, расходы — в указанной валюте. Временные метки — RFC 3339 с часовым поясом, даты расходов — YYYY-MM-DD. Регистр JSON-полей значим.

{"success": true, "data": [...]}

{"success": false, "error": "insufficient_permissions",
 "message": "This operation requires the 'read_stats' permission"}

Списки начислений, выплат и расходов поддерживают page (от 1) и limit (1–100, по умолчанию 20); ответ содержит meta с total, page, limit, totalPages. Список воркеров возвращается целиком и использует meta.pageSize; список субаккаунтов содержит total.

HTTPЗначение
200 / 201Успех / запись создана
400Некорректные параметры или тело запроса
401Неверная пара ключ/секрет, неактивный или истёкший ключ, IP вне разрешённого списка
403Недостаточно прав или доступ к объекту запрещён
404Объект не найден
409Конфликт с текущим состоянием объекта
429Ограничение частоты запросов; уменьшите частоту и повторите позже
500Ошибка обработки запроса

Проверяйте HTTP-статус и error. Не повторяйте автоматически операции записи после сетевого сбоя: сначала проверьте результат чтением.

Методы API

Загрузка справочника…