API Documentation
MCAPI.TR provides simple and efficient endpoints for monitoring Minecraft servers. Everything you need to know to get started is here.
GET
/api/v1/status/:address
The main endpoint that provides comprehensive information about any Minecraft server.
Example Requests
GET /api/v1/status/hypixel.netGET /api/v1/status/mc.hypixel.net:25565GET /api/v1/status/play.cubecraft.net?legacy=trueGET /api/v1/status/hivebedrock.network?bedrock=trueParameters
| apiDocs.endpoints.status.parameter | apiDocs.endpoints.status.type | The main endpoint that provides comprehensive information about any Minecraft server. |
|---|---|---|
address | string | Server IP address (e.g. hypixel.net) |
legacy | boolean | Set true for legacy version support |
bedrock | boolean | Set true for Bedrock servers |
Example Response
JSON
{
"query": {
"host": "cubecraft.net",
"port": 25565,
"legacy": false,
"bedrock": false
},
"server_id": "af2d95c3-0200-455d-90b2-1e8d8ba63965",
"ip_address": "193.105.184.230",
"icmp": true,
"online": true,
"error": null,
"version": {
"name": "§f§f§fWe support: 1.20-1.21",
"protocol": 340
},
"players": {
"online": 1592,
"max": 5000,
"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"
},
{
"name": "§6Rules §f> cubecraft.net/rules",
"id": "00000000-0000-0000-0000-000000000000"
},
{
"name": "§6Discord §f> discord.gg/cubecraft",
"id": "00000000-0000-0000-0000-000000000000"
},
{
"name": "§6Store §f> store.cubecraft.net",
"id": "00000000-0000-0000-0000-000000000000"
},
{
"name": "§6Twitter §f> twitter.com/CubeCraftGames",
"id": "00000000-0000-0000-0000-000000000000"
}
]
},
"motd": {
"raw": "§f §f◀ §9§lCubeCraft Games§9 [EU] §f▶§f
§f §6§lSUMMER EVENT §7§l+ §b§lSKYBLOCK UPDATE!",
"clean": " ◀ CubeCraft Games [EU] ▶
SUMMER EVENT + SKYBLOCK UPDATE!",
"html": "<span><span style="color: #FFFFFF;"> </span><span style="color: #FFFFFF;">◀ </span><span style="color: #5555FF; font-weight: bold;">CubeCraft Games</span><span style="color: #5555FF;"> [EU] </span><span style="color: #FFFFFF;">▶</span><span style="color: #FFFFFF;">
</span><span style="color: #FFFFFF;"> </span><span style="color: #FFAA00; font-weight: bold;">SUMMER EVENT </span><span style="color: #AAAAAA; font-weight: bold;">+ </span><span style="color: #55FFFF; font-weight: bold;">SKYBLOCK UPDATE!</span></span>",
"raw_lines": [
"§f §f◀ §9§lCubeCraft Games§9 [EU] §f▶§f",
"§f §6§lSUMMER EVENT §7§l+ §b§lSKYBLOCK UPDATE!"
],
"clean_lines": [
" ◀ CubeCraft Games [EU] ▶",
" SUMMER EVENT + SKYBLOCK UPDATE!"
],
"html_lines": [
"<span><span style="color: #FFFFFF;"> </span><span style="color: #FFFFFF;">◀ </span><span style="color: #5555FF; font-weight: bold;">CubeCraft Games</span><span style="color: #5555FF;"> [EU] </span><span style="color: #FFFFFF;">▶</span><span style="color: #FFFFFF;">
</span><span style="color: #FFFFFF;"> </span><span style="color: #FFAA00; font-weight: bold;">SUMMER EVENT </span><span style="color: #AAAAAA; font-weight: bold;">+ </span><span style="color: #55FFFF; font-weight: bold;">SKYBLOCK UPDATE!</span></span>"
]
},
"favicon": "data:image/png;base64,...",
"srvRecord": {
"host": "play.cubecraft.net",
"port": 25565
},
"roundTripLatency": 18
}GET
/api/icon/dynamic
Returns the server's favicon in PNG format. Returns default Minecraft server icon if no server is specified.
Example Requests
GET /api/icon/dynamic?address=hypixel.netDescription
Content-Type header returns as image/png . The result is directly an image file (64x64 PNG), if the server does not have an icon, a default icon is sent.