Hytale Status REST API Documentation

Introduction

The Hytale Status API provides free, public access to query the status of Hytale servers and the overall Hytale service status. Use this API in your Discord bots, websites, monitoring tools, or any other application.

Server Status

Query the status of any Hytale server.

Parameters

Example Request

Response (Online)

{
  "online": true,
  "version": "1.0.0",
  "players": {
    "online": 42,
    "max": 100
  },
  "motd": "§aWelcome to our server!",
  "motd_clean": "Welcome to our server!",
  "latency_ms": 45,
  "method": "nitrado",
  "server_info": {
    "name": "Example Server",
    "version": "1.0.0"
  }
}

Response (Offline)

{
  "online": false,
  "method": "nitrado",
  "error": "Server is offline or unreachable"
}

Hytale Service Status

Get the status of all official Hytale services.

Example Request

Response

{
  "timestamp": "2025-01-15T10:30:00.000Z",
  "allOperational": true,
  "services": [
    {
      "name": "Multiplayer Sessions",
      "description": "Create and join multiplayer game sessions",
      "status": "operational",
      "uptimeHistory": ["operational", "operational", ...]
    },
    {
      "name": "Account Login",
      "description": "Hytale account authentication and login",
      "status": "operational",
      "uptimeHistory": ["operational", "operational", ...]
    }
    // ... more services
  ]
}

Status Values

Error Handling

The API returns appropriate HTTP status codes along with error messages.

Code Examples

JavaScript / Node.js

// Check server status
const response = await fetch(
  'https://hytalestatus.org/api/server-status?host=play.example.com'
);
const data = await response.json();

if (data.online) {
  console.log(`Server is online with ${data.players.online} players`);
} else {
  console.log('Server is offline:', data.error);
}

Python

import requests

# Check server status
response = requests.get(
    'https://hytalestatus.org/api/server-status',
    params={'host': 'play.example.com', 'method': 'nitrado'}
)
data = response.json()

if data['online']:
    print(f"Server is online with {data['players']['online']} players")
else:
    print(f"Server is offline: {data.get('error', 'Unknown error')}")

cURL

# Check server status
curl "https://hytalestatus.org/api/server-status?host=play.example.com&method=nitrado"

# Check Hytale service status
curl "https://hytalestatus.org/api/hytale-status"

CORS Support

The API supports Cross-Origin Resource Sharing (CORS), allowing you to make requests directly from web browsers. All endpoints include the appropriate CORS headers.

Try It Without Code

Not a developer? Use our web-based tool to check any Hytale server status instantly, no coding required.