API Documentation

MCAPI.TR provides simple and efficient endpoints to monitor Minecraft servers. Here's everything you need to know to get started.

GET

/api/status/:address

The primary endpoint that provides comprehensive information about any Minecraft server.

Example Requests

GET /api/status/hypixel.net

GET /api/status/mc.hypixel.net:25565

GET /api/status/play.cubecraft.net?legacy=true

GET /api/status/hivebedrock.network?bedrock=true

Parameters

address

FQDN hostname or IP address (v4/v6)

Port can be appended with a colon (e.g. :25565)

legacy

For servers older than 1.7.2

Boolean (true/false)

bedrock

For Bedrock edition servers

Boolean (true/false)

Example Response

{
  "query": {
    "host": "cubecraft.net",
    "port": 25565,
    "legacy": false,
    "bedrock": false
  },
  "version": {
    "name": "§f",
    "protocol": 340,
  },
  "players": {
    "online": 860,
    "max": 2000,
    "sample": [
      {
        "name": "§4§k||§9§lCubeCraft§4§k||",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "name": "§6Forums §f> cubecraft.net",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ]
  },
  "motd": {
    "raw": "§f               §f◀ §9§lCubeCraft Games§9 [EU] §f▶§f\n§f         §d§lBEDWARS§f §7§l+§f §a§lPILLARS OF FORTUNE!",
    "clean": "               ◀ CubeCraft Games [EU] ▶\n         BEDWARS + PILLARS OF FORTUNE!",
    "html": "<span><span style=\"color: #FFFFFF;\">...</span></span>"
  },
  "favicon": "data:image/png;base64,<base64_encoded_image>",
  "srvRecord": {
    "host": "play.cubecraft.net",
    "port": 25565
  },
  "roundTripLatency": 43,
  "ip_address": "188.114.98.228",
  "icmp": true
}

GET

/api/icon/dynamic

Returns the server's favicon in PNG format. If no server is specified, returns the default Minecraft server icon.

Example Requests

GET /api/icon/dynamic

GET /api/icon/dynamic?address=hypixel.net

GET /api/icon/dynamic?address=mc.hypixel.net:25565

GET /api/icon/dynamic?address=play.cubecraft.net?legacy=true

Default

Cubecraft

Hypixel

2b2t

GET

/api/banner/:address

Returns the server's MOTD as a PNG banner with accurate Minecraft color codes.

Cubecraft Banner:

2b2t Banner: