Как работает Barfinex
Справочник API Inspector
REST API Barfinex Inspector: опции, health, дашборд риска, KPI, runtime-позиции, цены, ликвидность и аудит.
Обзор
Inspector предоставляет REST API для конфигурации, health, дашборда риска, KPI, runtime-позиций, кэша цен, снимков ликвидности и аудита (живой и QuestDB).
- Базовый URL при вызове через Provider:
GET|PUT /api/inspectors/:appKey/...(напримерappKey=inspector) - Прямой базовый URL:
{inspectorUrl}/api(порт по умолчанию 8008)
Все пути ниже — относительно /api. При использовании прокси Provider префикс пути: /api/inspectors/:appKey/inspector/... как в таблице.
REST-эндпоинты (сводка)
| Метод | Путь (на Inspector) | Описание |
|---|---|---|
| GET | /inspector/options | Текущие опции Inspector |
| PUT | /inspector/options | Обновить опции (body: { options }) |
| GET | /inspector/health | Health check (ok, коннекторы, timestamp) |
| GET | /inspector/risk/dashboard | Полный дашборд риска (KPI, runtime-позиции, хвост аудита) |
| GET | /inspector/risk/kpi | Только снимок KPI риска |
| GET | /inspector/risk/runtime-positions | Позиции под управлением (runtime) |
| GET | /inspector/risk/prices | Последние цены из кэша риск-движка |
| GET | /inspector/risk/liquidity | Последние снимки ликвидности |
| GET | /inspector/risk/audit | Живой хвост аудита (query: limit, по умолчанию 200) |
| GET | /inspector/risk/audit/questdb | Аудит риска из QuestDB (query: limit, по умолчанию 200) |
Через прокси Provider
| Ресурс | Пример пути Provider |
|---|---|
| Опции | GET /api/inspectors/:appKey/inspector/options, PUT .../inspector/options |
| Health | GET /api/inspectors/:appKey/inspector/health |
| Дашборд риска | GET /api/inspectors/:appKey/inspector/risk/dashboard |
| KPI | GET /api/inspectors/:appKey/inspector/risk/kpi |
| Runtime-позиции | GET /api/inspectors/:appKey/inspector/risk/runtime-positions |
| Цены | GET /api/inspectors/:appKey/inspector/risk/prices |
| Ликвидность | GET /api/inspectors/:appKey/inspector/risk/liquidity |
| Живой аудит | GET /api/inspectors/:appKey/inspector/risk/audit?limit=200 |
| Аудит QuestDB | GET /api/inspectors/:appKey/inspector/risk/audit/questdb?limit=200 |
Ответ дашборда обычно включает kpi (equity, просадка, дневной PnL, закрытые сделки, выигрыши/проигрыши, подряд убытков, стресс-режим), runtimePositions, activeRuntimeManaged и auditTail.
События (для интеграторов)
Inspector потребляет рыночные и ордерные события с шины и публикует события риска. Для получения риска и рыночных данных в реальном времени используйте WebSocket Provider (/ws) и подпишитесь на события INSPECTOR_RISK_LIMIT_BREACH, INSPECTOR_RISK_KILL_SWITCH и другие типы INSPECTOR_*. Подключаться к Inspector или шине напрямую не требуется.
Дальше
- Обзор Inspector — Роль и установка
- Политики риска Inspector — Опции конфигурации
- Справочник API Provider — Прокси и WebSocket