GameAPIs

Minecraft Query Documentation

Parameters

Required Parameter Type Description Default Value
True IP String Server's IP address or domain None
False Port Integer The port of which the Minecraft server is running on. 25565
False Options String (Banners only) Set the background & if the text should be capitalised. None

Default

GET https://use.gameapis.net/mc/query/banner/{IP}:{PORT}

Night with capitalisation

GET https://use.gameapis.net/mc/query/banner/{IP}:{PORT}/night,caps

Sunset

GET https://use.gameapis.net/mc/query/banner/{IP}:{PORT}/sunset

Nether with capitalisation

GET https://use.gameapis.net/mc/query/banner/{IP}:{PORT}/nether,caps

Default with capitalisation

GET https://use.gameapis.net/mc/query/banner/{IP}:{PORT}/caps

Default Offline server [It's icon may change soon]

GET https://use.gameapis.net/mc/query/banner/{IP}:{PORT}/caps

Single Server

GET https://use.gameapis.net/mc/query/status/{IP}:{PORT}
{
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "tcp",
        "ping": 2,
        "cached": false
    }

Multiple Servers

GET https://use.gameapis.net/mc/query/status/{IP}:{PORT},{IP2}:{PORT2}
{
        "{IP}:{PORT}": {
            "status": true,
            "hostname": "{IP}",
            "port": {PORT},
            "protocol": "tcp",
            "ping": 2,
            "cached": false
        },
        "{IP2}:{PORT2}": {
            "status": true,
            "hostname": "{IP2}",
            "port": {PORT2},
            "protocol": "tcp",
            "ping": 43,
            "cached": false
        }
    }

Single Server

GET https://use.gameapis.net/mc/query/players/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "protocol": "tcp",
    "players": {
        "online": 253,
        "max": 500
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mc/query/players/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "tcp",
        "players": {
            "online": 126,
            "max": 250
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "protocol": "tcp",
        "players": {
            "online": 382,
            "max": 500
        },
        "cached": false
    }
}

Single Server

GET https://use.gameapis.net/mc/query/info/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "ping": 53,
    "version": "BungeeCord 1.8.x, 1.9.x, 1.10.x, 1.11.x",
    "protocol": "tcp",
    "players": {
        "online": 257,
        "max": 500
    },
    "motds": {
        "ingame": "§bMinecraft Server",
        "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
        "clean": "Minecraft Server"
    },
    "favicon": "data:image/png;base64,{insert long base64 code}",
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mc/query/info/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "ping": 2,
        "version": "BungeeCord 1.8.x, 1.9.x, 1.10.x, 1.11.x",
        "protocol": "tcp",
        "players": {
            "online": 252,
            "max": 500
        },
        "motds": {
            "ingame": "§bMinecraft Server",
            "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
            "clean": "Minecraft Server"
        },
        "favicon": "data:image/png;base64,{insert long base64 code}",
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "ping": 3,
        "version": "BungeeCord 1.8.x-1.12.x",
        "protocol": "tcp",
        "players": {
            "online": 40,
            "max": 41
        },
        "motds": {
            "ingame": "§bMinecraft Server",
            "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
            "clean": "Minecraft Server"
        },
        "favicon": "data:image/png;base64,{insert long base64 code}",
        "cached": false
    }
}

Single Server

GET https://use.gameapis.net/mc/query/icon/{IP}:{PORT}

Single Server

GET https://use.gameapis.net/mc/query/motd/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "protocol": "tcp",
    "ping": 53,
    "motds": {
        "ingame": "§bMinecraft Server",
        "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
        "clean": "Minecraft Server"
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mc/query/motd/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "tcp",
        "ping": 2,
        "motds": {
            "ingame": "§bMinecraft Server",
            "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
            "clean": "Minecraft Server"
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "protocol": "tcp",
        "ping": 3,
        "motds": {
            "ingame": "§bMinecraft Server",
            "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
            "clean": "Minecraft Server"
        },
        "cached": false
    }
}

Extensive Query enable-query needs to be set to true in server.properties.

Single Server

GET https://use.gameapis.net/mc/query/extensive/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "protocol": "udp",
    "version": "1.12",
    "software": "CraftBukkit on Bukkit 1.12-R0.1-SNAPSHOT",
    "game_type": "SMP",
    "game_name": "MINECRAFT",
    "motds": {
        "ingame": "§bMinecraft Server",
        "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
        "clean": "Minecraft Server"
    },
    "map": "world",
    "players": {
        "online": 1,
        "max": 20
    },
    "list": [
        "Yive"
    ],
    "plugins": [
        "Vault 1.5.6-b49"
    ],
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mc/query/extensive/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "udp",
        "version": "1.12",
        "software": "CraftBukkit on Bukkit 1.12-R0.1-SNAPSHOT",
        "game_type": "SMP",
        "game_name": "MINECRAFT",
        "motds": {
            "ingame": "§bMinecraft Server",
            "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
            "clean": "Minecraft Server"
        },
        "map": "world",
        "players": {
            "online": 1,
            "max": 20
        },
        "list": [
            "Yive"
        ],
        "plugins": [
            "Vault 1.5.6-b49"
        ],
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "protocol": "udp",
        "version": "1.12",
        "software": "CraftBukkit on Bukkit 1.12-R0.1-SNAPSHOT",
        "game_type": "SMP",
        "game_name": "MINECRAFT",
        "motds": {
            "ingame": "§bMinecraft Server",
            "html": "<span style=\"color:#55ffff\">Minecraft Server</span>",
            "clean": "Minecraft Server"
        },
        "map": "world",
        "players": {
            "online": 0,
            "max": 20
        },
        "list": null,
        "plugins": [
            "Vault 1.5.6-b49"
        ],
        "cached": false
    }
}