GameAPIs

Minecraft: Pocket Edition Documentation

Minecraft: Pocket Edition servers run entirely on the UDP protocol. Some countries / hosts will block incoming UDP requests which may cause servers to appear offline.

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

Single Server

GET https://use.gameapis.net/mcpe/query/status/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "protocol": "udp",
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mcpe/query/status/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "udp",
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "protocol": "udp",
        "cached": false
    }
}

Single Server

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

Multiple Servers

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

Single Server

GET https://use.gameapis.net/mcpe/query/info/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "protocol": "udp",
    "version": "1.1.3.1",
    "motds": {
        "ingame": "§bMinecraft PE Server",
        "html": "<span style=\"color:#55ffff\">Minecraft PE Server</span>",
        "clean": "Minecraft PE Server"
    },
    "players": {
        "online": 257,
        "max": 500
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mcpe/query/info/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "udp",
        "version": "1.1.3.1",
        "motds": {
            "ingame": "§bMinecraft PE Server",
            "html": "<span style=\"color:#55ffff\">Minecraft PE Server</span>",
            "clean": "Minecraft PE Server"
        },
        "players": {
            "online": 257,
            "max": 500
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "protocol": "udp",
        "version": "1.1.0.55",
        "motds": {
            "ingame": "§bMinecraft PE Server",
            "html": "<span style=\"color:#55ffff\">Minecraft PE Server</span>",
            "clean": "Minecraft PE Server"
        },
        "players": {
            "online": 380,
            "max": 600
        },
        "cached": false
    }
}

Single Server

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

Multiple Servers

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

Extensive Query Depending on the software, query needs to be enabled in the software's config.

Single Server

GET https://use.gameapis.net/mcpe/query/extensive/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "protocol": "udp",
    "version": "0.15.0",
    "software": "MiNET v1.0.0",
    "game_type": "SMP",
    "game_name": "MINECRAFTPE",
    "motd": "Minecraft PE Server",
    "map": "world",
    "players": {
        "online": 1,
        "max": 20
    },
    "list": [
        "ItsYive"
    ],
    "plugins": [
        "BuyCraft 1.2.1"
    ],
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/mcpe/query/extensive/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "udp",
        "version": "0.15.0",
        "software": "MiNET v1.0.0",
        "game_type": "SMP",
        "game_name": "MINECRAFTPE",
        "motd": "Minecraft PE Server",
        "map": "world",
        "players": {
            "online": 1,
            "max": 20
        },
        "list": [
            "ItsYive"
        ],
        "plugins": [
            "BuyCraft 1.2.1"
        ],
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "protocol": "udp",
        "version": "v1.1.0.55",
        "software": "PocketMine-MP 1.6.2dev",
        "game_type": "SMP",
        "game_name": "MINECRAFTPE",
        "motd": "Minecraft PE Server",
        "map": "world",
        "players": {
            "online": 0,
            "max": 20
        },
        "list": null,
        "plugins": null,
        "cached": false
    }
}