Skip to main content
GET
/
v3
/
games
/
minecraft
/
lookup
Get Minecraft Server
curl --request GET \
  --url https://api.ricardoneud.com/v3/games/minecraft/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Address: <x-address>'
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Address
string
required

The address (domain or IP) of the Minecraft server

​
X-Port
string

The port of the Minecraft server (default is 25565)

Response

200 - 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.
​
ip
string
required
​
port
string
required
​
players
object
required
​
version
object
required
​
ping
string
required
​
srvRecord
object
required
⌘I