Java Server Status

Endpoint: /api/status/:serverAddress

Method: GET

Success Response:

{
  "success": true,
  "version": {
    "name": "1.16.5",
    "protocol": 754
  },
  "players": {
    "max": 20,
    "online": 5,
    "list": [
      {
        "name": "EducatedSuddenBucket",
        "id": "uuid1"
      },
      {
        "name": "SomeoneElseInTheServer",
        "id": "uuid2"
      }
    ]
  },
  "description": "A Minecraft Server",
  "description_clean": "A Minecraft Server",
  "latency": 123,
  "favicon": "data:image/png;base64,..."
}

Error Responses:

{
  "success": false,
  "error": {
    "code": "timeout",
    "message": "Connection to server timed out"
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_domain",
    "message": "The domain name could not be resolved"
  }
}

{
  "success": false,
  "error": {
    "code": "connection_refused",
    "message": "Server refused the connection"
  }
}

{
  "success": false,
  "error": {
    "code": "offline",
    "message": "Server appears to be offline or unreachable"
  }
}

Server Icon (Java Only)

Endpoint: /api/png/:serverip

Method: GET

Success Response: Image (PNG)

Error Responses:

{
  "success": false,
  "error": {
    "code": "timeout",
    "message": "Connection to server timed out"
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_domain",
    "message": "The domain name could not be resolved"
  }
}

{
  "success": false,
  "error": {
    "code": "connection_refused",
    "message": "Server refused the connection"
  }
}

{
  "success": false,
  "error": {
    "code": "offline",
    "message": "Server appears to be offline or unreachable"
  }
}

{
  "success": false,
  "error": {
    "code": "no_favicon",
    "message": "Server does not have a favicon"
  }
}

Bedrock Server Status

Endpoint: /api/status/bedrock/:serverAddress

Method: GET

Success Response:

{
  "success": true,
  "motd": "Dedicated Server",
  "motd_clean": "Dedicated Server",
  "levelName": "Bedrock level",
  "playersOnline": 0,
  "playersMax": 10,
  "gamemode": "Survival",
  "serverId": "13460148391903423507",
  "protocol": "486",
  "version": "1.18.0",
  "latency": 50
}

Error Responses:

{
  "success": false,
  "error": {
    "code": "timeout",
    "message": "Connection to server timed out"
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_domain",
    "message": "The domain name could not be resolved"
  }
}

{
  "success": false,
  "error": {
    "code": "connection_refused",
    "message": "Server refused the connection"
  }
}

{
  "success": false,
  "error": {
    "code": "offline",
    "message": "Server appears to be offline or unreachable"
  }
}