Get Minecraft Server

Obsolete

GET

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

Maintainer:Ricardoneud.com

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.ricardoneud.com/v2/games/minecraft/lookup' \
--header 'X-Address;' \
--header 'X-Port;'

Response 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
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Responses

🟢200Success

application/json

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.

Body

Modified at 2025-07-27 13:13:23

Get Licenses

Check License