Skip to content
Ricardoneud.com

Get Minecraft Server

This documentation helps you retrieve the status of a Minecraft server by providing its address and port.

Further Reading: Retrieving Minecraft Server Status

You can retrieve the status of a Minecraft server by making a request to the following API endpoint:

GET https://api.ricardoneud.com/v2/games/minecraft/lookup

Request Headers:

HeaderTypeRequiredDescription
Authorizationstring✅Bearer token with a valid API key
X-Addressstring✅The address (domain or IP) of the Minecraft server
X-Portstring❌The port of the Minecraft server (default is 25565)

Example Response

The response will contain the status of the Minecraft server, including the IP address, port, player count, version, latency, and SRV record.

Example:

{
    "ip": "192.168.1.1",
    "port": "25565",
    "players": {
        "online": 10,
        "max": 20
    },
    "version": {
        "name": "1.19.2",
        "protocol": 760
    },
    "ping": "50 ms",
    "srvRecord": {
        "host": "example.com",
        "port": 25565
    }
}

Fields in the Response:

  • ip: The IP address of the Minecraft server.
  • port: The port on which the Minecraft server is running.
  • players: Information about the number of players online and the maximum capacity.
    • online: The number of players currently online.
    • max: The maximum number of players the server can support.
  • version: Information about the server’s version.
    • name: The name of the server version.
    • protocol: The protocol version number.
  • ping: The latency of the server in milliseconds.
  • srvRecord: The SRV record associated with the server, if available.

Error Responses

  • 400 Bad Request: Missing address in headers.
  • 401 Unauthorized: Invalid or missing API key, or insufficient permissions.
  • 500 Internal Server Error: Database error or failed to perform Minecraft server check.