OpenAPI 3.0 REST v1 JSON Protocol

SoilWorker REST API

Единый программный интерфейс для синхронизации данных между сервисами, хранения структурированных коллекций и финансово-инвестиционной аналитики портфелей (Prognosis).

Спецификация openapi.json Войти в систему
Базовый URL
http://soilworker.ru/api/v1/
Формат ответов
application/json (UTF-8)
Авторизация по личному токену

Используется для вызовов большинства эндпоинтов управления проектами, сделками и аналитикой портфелей. Передаётся в заголовке Authorization: Token <ваш_токен>.

Для получения токена выполните POST-запрос:
POST /api/auth/token/ {"username": "...", "password": "..."}
# Пример запроса с токеном curl -H "Authorization: Token ВАШ_ТОКЕН" \ http://soilworker.ru/api/v1/prognosis/portfolios/
Авторизация по ключу проекта (X-Project-Key)

Применяется внешними микросервисами, демонами и скриптами для выгрузки (Push) и чтения (Pull) данных, а также сбора котировок без привязки к сессии пользователя.

Ключ проекта (формат proj_...):
Генерируется автоматически в карточке проекта или панели управления.
# Запрос с ключом проекта curl -H "X-Project-Key: proj_ВАШ_КЛЮЧ_ПРОЕКТА" \ http://soilworker.ru/api/v1/sync/pull/?collection=users
POST /api/v1/sync/push/ (Выгрузка данных)

Отправка массива записей items. Если передан external_id, сервис выполняет update_or_create.

curl -X POST http://soilworker.ru/api/v1/sync/push/ \ -H "Content-Type: application/json" \ -H "X-Project-Key: proj_ВАШ_КЛЮЧ" \ -d '{ "items": [ { "collection": "users", "external_id": "usr_1024", "payload": { "email": "user@example.com", "name": "Иван Иванов", "is_active": true }, "version": 1 } ] }'
GET /api/v1/sync/pull/ (Получение данных)

Запрос последних 500 записей проекта с опциональной фильтрацией по параметру ?collection=....

curl -X GET "http://soilworker.ru/api/v1/sync/pull/?collection=users" \ -H "X-Project-Key: proj_ВАШ_КЛЮЧ"
Сводка портфеля с аналитикой

Получение актуальных позиций, кэша по валютам, нереализованной прибыли и пересчета в валюту пользователя.

# Получение сводки портфеля "main" curl -H "Authorization: Token ВАШ_ТОКЕН" \ http://soilworker.ru/api/v1/prognosis/portfolios/main/summary/
Синхронизация котировок

Запуск регулярного сбора котировок по всем отслеживаемым компаниям (РФ: MOEX / T-Invest; Мир: Yahoo / Twelve Data).

curl -X POST http://soilworker.ru/api/v1/prognosis/prices/sync/ \ -H "Authorization: Token ВАШ_ТОКЕН" \ -H "Content-Type: application/json" \ -d '{"market": "all"}'

Интерактивная спецификация API

Загрузка спецификации и компонентов Swagger UI...