Справочник API

Полный справочник REST API и WebSocket эндпоинтов Yoyo Market (далее — Yoyo).

Базовый URL

https://yoyo.market/api/v1/

Все эндпоинты указаны относительно данного базового URL, кроме партнёрской интеграции — см. ниже.

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

Yoyo использует JWT-токены, передаваемые в виде HTTP-only cookies:

access_token — Краткосрочный (20 мин), необходим для аутентифицированных эндпоинтов
refresh_token — Долгосрочный (72 часа), используется для получения новых access-токенов

После входа в систему cookies устанавливаются автоматически. Для программного доступа включайте cookies в запросы или используйте заголовок Authorization:

Authorization: Bearer <access_token>

Уровни аутентификации

Уровень	Описание
None	Публичный эндпоинт, аутентификация не требуется
Optional	Работает с аутентификацией и без неё (может возвращать разные данные)
Required	Требуется аутентификация
Creator	Требуется роль `is_creator`
StatsViewer	Требуется роль `is_stats_viewer`

Формат запроса

Content-Type: application/json для всех запросов POST/PUT/PATCH
Максимальный размер тела: 1 МБ
Временные метки: формат RFC3339 (2024-01-15T10:30:00Z)
Деньги: все суммы в копейках. См. Формат денежных значений

Формат ответа

Успешный ответ

Большинство эндпоинтов возвращают ресурс напрямую:

{
  "id": 42,
  "name": "Example Event",
  "status": "started"
}

Пагинированные эндпоинты возвращают:

{
  "events": [],
  "next_cursor": "abc123",
  "has_more": true
}

Ответ с ошибкой

Все ошибки имеют единый формат:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}

Полный справочник кодов ошибок см. в разделе Обработка ошибок.

Ограничение частоты запросов

Все эндпоинты имеют ограничение частоты запросов по IP-адресу. Заголовки ответа:

Заголовок	Описание
`X-RateLimit-Limit`	Максимальное количество запросов за период
`X-RateLimit-Remaining`	Оставшееся количество запросов
`X-RateLimit-Reset`	Время сброса окна (Unix timestamp)

Подробнее см. Ограничение частоты запросов.

Группы эндпоинтов

Группа	Префикс	Описание
Аутентификация	`/auth/`	Регистрация, вход, OAuth, обновление токенов
Пользователи	`/users/`	Профиль, аватар, PnL
Рефералы	`/users/me/referral/`	Реферальная программа
Избранное	`/users/me/watchlist/`	Сохранённые события
События	`/events/`	CRUD событий, поиск, лента
Пулы	`/pools/`	Детали пулов, графики
Рынки	`/markets/`	Детали рынков, книга ордеров
Торговля	`/market/orders/`	Ордера в книге ордеров, позиции
LMSR/AMM	`/lmsr/`	AMM-сделки и предпросмотр
Партнёрская интеграция	`/partner/`	B2B-интеграция по модели «флоат»: ставки за пользователей партнёра
Креаторы	`/creators/`	Инструменты креаторов (исходы Polymarket)
P2P-обмен	`/p2p/`	Объявления, ордера, чат
Уведомления	`/notifications/`	Управление прочитанными/непрочитанными
Комментарии	`/comments/`	Комментарии к событиям
Чат	`/chat/`	Чат поддержки
WebSocket	`/ws/`	Потоки данных в реальном времени
Активы	`/assets/`	Цены криптовалют, курсы валют
Здоровье	`/health`	Проверка состояния

Эндпоинты партнёрской интеграции используют собственный базовый URL, указанный на их странице обзора.

Для эндпоинтов P2P доступна готовая коллекция Postman (формат Postman v2.1; после импорта задайте переменные base_url и access_token). Коллекция передаёт токен в cookie access_token — так же, как его ожидает бэкенд от веб-клиента; API также принимает заголовок Authorization: Bearer <token>.

Базовый URL​

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

Уровни аутентификации​

Формат запроса​

Формат ответа​

Успешный ответ​

Ответ с ошибкой​

Ограничение частоты запросов​

Группы эндпоинтов​