Query Server

GET /server/(platform)/(query)

Ping a Java or Bedrock server and retrieve it's status.

View the Swagger Docs for more.

Path Variables

Name	Type	Description
platform	string	`JAVA` or `BEDROCK`
hostname	string	`The server hostname to lookup (Append :<port> for port)`

Error Codes

Code	Description
`400 (BAD_REQUEST)`	The platform, hostname, or port is invalid
`404 (NOT_FOUND)`	The requested server couldn't be found

Cache

Results are cached for up to 1 minute

Java Response

{
    "hostname": "mc.hypixel.net",
    "ip": "209.222.115.100",
    "port": 25565,
    "records": [
        {
            "type": "SRV",
            "ttl": 228,
            "priority": 1,
            "weight": 1,
            "port": 25565,
            "target": "mc.hypixel.net"
        },
        {
            "type": "A",
            "ttl": 23,
            "address": "209.222.115.100"
        }
    ],
    "players": {
        "online": 49063,
        "max": 200000
    },
    "motd": {
        "raw": [
            "                §aHypixel Network §c[1.8-1.20]",
            "   §b§lSB 0.20 §f§lGLACITE TUNNELS §7| §6§lTNT UPDATE"
        ],
        "clean": [
            "                Hypixel Network [1.8-1.20]",
            "   SB 0.20 GLACITE TUNNELS | TNT UPDATE"
        ],
        "html": [
            "                <span style=\"color:#55FF55\">Hypixel Network <span style=\"color:#FF5555\">[1.8-1.20]",
            "   <span style=\"color:#55FFFF\"><span style=\"color:\">SB 0.20 <span style=\"color:#FFFFFF\"><span style=\"color:\">GLACITE TUNNELS <span style=\"color:#AAAAAA\">| <span style=\"color:#FFAA00\"><span style=\"color:\">TNT UPDATE"
        ]
    },
    "version": {
        "name": "Requires MC 1.8 / 1.20",
        "protocol": 47,
        "protocolName": "1.8"
    },
    "favicon": {
        "base64": "data:image/png;base64,iV…mHEPQgkAAAAASUVORK5CYII=...",
        "url": "https://api.restfulmc.cc/server/icon/mc.hypixel.net"
    },
    "previewsChat": false,
    "enforcesSecureChat": false,
    "preventsChatReports": false,
    "mojangBanned": false,
    "cached": 1713024877386 // -1 if not cached
}

Bedrock Response

{
    "hostname": "gateway.wildnetwork.net",
    "ip": "198.244.215.7",
    "port": 19132,
    "records": [
        {
            "type": "A",
            "ttl": 300,
            "address": "198.244.215.7"
        }
    ],
    "players": {
        "online": 0,
        "max": 1000
    },
    "motd": {
        "raw": [
            "WildNetwork",
            "WildNetwork - Prison - SMP"
        ],
        "clean": [
            "WildNetwork",
            "WildNetwork - Prison - SMP"
        ],
        "html": [
            "WildNetwork",
            "WildNetwork - Prison - SMP"
        ]
    },
    "id": "12929675432988707659",
    "edition": "MCPE",
    "version": {
        "protocol": 662,
        "name": "1.20.70"
    },
    "gamemode": {
        "name": "Survival",
        "numericId": 1
    },
    "cached": 1713025005404 // -1 if not cached
}