API документация

Обзор

HyServer предоставляет бесплатный REST API для разработчиков. Вы можете получать данные о серверах Hytale для своих приложений, ботов и веб-сайтов.

https://hyserver.ru/api/

Эндпоинты

GET/api/servers

Получить список всех серверов

# Пример запроса
curl "https://hyserver.ru/api/servers"

GET/api/servers/:id

Получить информацию о конкретном сервере

# Пример запроса
curl "https://hyserver.ru/api/servers/abc123"

GET/api/servers/:id/history

Получить историю онлайна сервера (period: day, week, month)

# Пример запроса
curl "https://hyserver.ru/api/servers/abc123/history?period=week"

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

Все ответы возвращаются в формате JSON:

{
  "id": "abc123",
  "name": "My Hytale Server",
  "domain": "play.myserver.com",
  "status": "online",
  "players": 42,
  "maxPlayers": 100,
  "version": "1.0.0",
  "gameMode": "PVP"
}

Лимиты запросов

API ограничен 100 запросами в минуту на IP-адрес. При превышении лимита вы получите ответ с кодом 429 (Too Many Requests).

Вернуться на главную