Build Minecraft
Server Monitors

Quick Start

Start querying server status in seconds — no auth required for the REST API on the basic plan.

const ws = new WebSocket(
  'wss://mc.fizzystudio.xyz/ws/v2?api_key=YOUR_KEY'
);

ws.onopen = () => {
  ws.send(JSON.stringify({
    type: 'subscribe',
    server: 'mc.hypixel.net'
  }));
};

ws.onmessage = ({ data }) => {
  const msg = JSON.parse(data);
  console.log(msg); // Full server status
};

// msg.icon is already a full data URI:
img.src = msg.icon;
// → data:image/png;base64,iVBORw0K...

Authentication

The REST API (v1) is publicly accessible for the basic plan. The WebSocket v2 feed requires an API Key for access.

wss://mc.fizzystudio.xyz/ws/v2?api_key=YOUR_API_KEY

Authorization: Bearer YOUR_API_KEY

Server Status

Returns detailed real-time information about a Minecraft server. Supports both hostnames and IP:port combinations.

Path Parameters

Response Fields

Example Response

{
  "online": true,
  "ip": "mc.hypixel.net",
  "numericIp": "172.65.196.2",
  "port": 25565,
  "motd": {
    "raw": "§f                §aHypixel Network §c[1.8/1.21]",
    "clean": "                Hypixel Network [1.8/1.21]",
    "html": "<span><span style=\"color:#55FF55\">Hypixel Network</span>...</span>"
  },
  "players": {
    "online": 45210,
    "max": 200000
  },
  "version": "Requires MC 1.8 / 1.21",
  "protocol": 47,
  "software": "BungeeCord",
  "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "eula_blocked": false
}

Server Icon

Returns the server's favicon as a raw PNG image. Useful for displaying server icons in <img> tags without handling Base64 yourself.

Usage in HTML

<!-- Direct image URL -->
<img src="https://mc.fizzystudio.xyz/icon/v1/mc.hypixel.net"
     alt="Hypixel Icon" width="64" height="64">

<!-- Or using the Base64 from the /status endpoint -->
<img src="${msg.icon}" alt="Server Icon">

Real-time Updates

Connect once and receive live server data the moment anything changes. No polling, no delays — pure event-driven updates.

Client Messages

Connection Limits

Events

All server→client messages are JSON objects with a type field. Events fire the instant data changes.

{
  "type": "status_update",
  "server": "mc.hypixel.net",
  "online": true,
  "players": {
    "online": 22765,
    "max": 200000,
    "list": []
  },
  "motd": {
    "clean": "Hypixel Network [1.8/1.21] — BUILD BATTLE PLATINUM PALETTE",
    "raw": "§f§aHypixel Network §c[1.8/1.21]...",
    "html": "<span style=\"color:#55FF55\">Hypixel Network</span>..."
  },
  "version": {
    "name": "Requires MC 1.8 / 1.21",
    "protocol": 47
  },
  "icon": "data:image/png;base64,iVBORw0KGgoAAAA...",
  "software": "BungeeCord",
  "eula_blocked": false,
  "latency": 1500,
  "timestamp": 1678567200
}

{
  "type": "server_offline",
  "server": "mc.hypixel.net",
  "timestamp": 1678567300
}

// Received from server:
{"type": "ping"}

// You must send back:
ws.send(JSON.stringify({ type: "pong" }));

{"type": "subscribed", "server": "mc.hypixel.net"}

WebSocket Error Codes

Errors are sent as JSON before the connection is closed.

Plans & Limits

API rate limits are enforced per IP address for REST and per API key for WebSocket. Limits reset every 24 hours.

HTTP Error Codes

Standard HTTP status codes are used for REST API responses.

Minecraft-Specific Notes