Minecraft server status

The public status of a Minecraft Java Edition server, as the in-game server list shows it: online or not, version name and protocol, players online and maximum with the player sample the server lists, the MOTD (plain text, lines and the original formatted component), the server icon as a data URI, secure-chat flag, mod loader and mod list for modded servers, and the round-trip time. The server's SRV record is followed when no port is given. A server that does not answer returns online: false with the reason.

Every response includes credits_used: the credits this call cost.

Parameters

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/minecraft/v1/server-status?address=mc.hypixel.net" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/minecraft/v1/server-status",
    params={"address": "mc.hypixel.net"},
    headers={"x-api-key": os.environ["APISH_KEY"]},
    timeout=120,
)
res.raise_for_status()
data = res.json()

const url = new URL("https://api.api.sh/minecraft/v1/server-status");
url.searchParams.set("address", "mc.hypixel.net");

const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

Response

A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).