Как работает Barfinex
Справочник API Detector
REST API Barfinex Detector: выбор детектора, health, состояние, опции, счета, сделки, метрики, плагины и закрытие позиции по риску.
Обзор
Detector — движок сигналов. Его REST API используется для выбора активного детектора, чтения состояния и метрик, управления плагинами и запроса закрытия позиции по риску.
- Базовый URL при вызове через Provider:
GET|POST /api/detectors/:appKey/...(напримерappKey=detector) - Прямой базовый URL:
{detectorUrl}/api(порт по умолчанию 8101)
Все пути ниже — относительно /api. При использовании прокси Provider путь имеет вид /api/detectors/:appKey/detector/... или /api/detectors/:appKey/risk/... как в таблице.
REST-эндпоинты (сводка)
| Метод | Путь (на Detector) | Описание |
|---|---|---|
| GET | /detector/select | Переключить активный детектор (query: sysName) |
| GET | /detector/active | Получить активный детектор |
| GET | /detector/health | Health check и готовность |
| GET | /detector/state | Полное состояние (опции, метрики, время) |
| GET | /detector/options | Текущие и предыдущие опции детектора |
| GET | /detector/accounts | Счета детектора |
| GET | /detector/trades/last | Последние сделки по символам |
| GET | /detector/performance | Метрики производительности активного детектора |
| POST | /detector/plugins/:studioGuid/install | Установить плагин |
| GET | /detector/plugins/installed | Список установленных плагинов |
| GET | /detector/plugins/:studioGuid | Детали плагина |
| POST | /risk/close-position | Закрыть позицию по риску (body: symbol, connectorType, marketType, side?, quantity?, reason) |
Через прокси Provider
| Ресурс | Пример пути Provider |
|---|---|
| Выбор детектора | GET /api/detectors/:appKey/detector/select?sysName=... |
| Активный детектор | GET /api/detectors/:appKey/detector/active |
| Health | GET /api/detectors/:appKey/detector/health |
| State | GET /api/detectors/:appKey/detector/state |
| Options | GET /api/detectors/:appKey/detector/options |
| Accounts | GET /api/detectors/:appKey/detector/accounts |
| Last trades | GET /api/detectors/:appKey/detector/trades/last |
| Performance | GET /api/detectors/:appKey/detector/performance |
| Плагины | POST /api/detectors/:appKey/detector/plugins/:studioGuid/install, GET .../plugins/installed, GET .../plugins/:studioGuid |
| Закрытие позиции | POST /api/detectors/:appKey/risk/close-position |
Эндпоинты плагинов могут требовать аутентификации. Тело запроса close-position: symbol, connectorType, marketType, опционально side, quantity, reason; в ответе — success, при успехе orderId, symbol, side, closedQuantity, при ошибке — сообщение.
События (для интеграторов)
Detector потребляет рыночные и счётные события с шины (от Provider) и события риска (от Inspector). Публикует сигналы и запросы по позициям. Для реального времени в вашем приложении используйте WebSocket Provider (/ws); подключаться к Detector или шине напрямую не нужно. Подпишитесь на события DETECTOR_SIGNAL_GENERATED, DETECTOR_SIGNAL_UPDATED, DETECTOR_SIGNAL_INVALIDATED и запросы по позициям.
Дальше
- Справочник API Provider — Прокси и WebSocket
- Работа с API — Схема единого шлюза