MCAPITR

MCAPITR is a Node.js wrapper for the MCAPI.TR service, which provides various Minecraft server information.

Installation

npm install mcapitr

yarn add mcapitr

pnpm add mcapitr

bun add mcapitr

Usage

Server Information

const MCAPITR = require("mcapitr");
const mcapitr = new MCAPITR();

// Get server status
mcapitr
  .serverStatus("cubecraft.net")
  .then((status) => {
    console.log(status);
    // {
    //   "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"
    //       }
    //     ]
    //   },
    //   "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>",
    //   "roundTripLatency": 43
    // }
  })
  .catch((err) => console.error(err));

// Get server icon URL
const iconURL = mcapitr.serverIcon("cubecraft.net");
console.log(iconURL);
// https://mcapi.tr/api/icon/dynamic?address=cubecraft.net

// Get server banner URL
const bannerURL = mcapitr.serverBanner("cubecraft.net");
console.log(bannerURL);
// https://mcapi.tr/api/banner/cubecraft.net

API

Server Methods

serverStatus(address, options?)

Gets the status of a Minecraft server.

• address: Server address (IP or domain)
• options:
  • legacy: Boolean - For servers older than 1.7.2
  • bedrock: Boolean - For Bedrock edition servers
• Returns: Promise with server status information

serverIcon(address, options?)

Gets the favicon URL of a Minecraft server.

• address: Server address (IP or domain)
• options:
  • legacy: Boolean - For servers older than 1.7.2
• Returns: String URL of the server icon

serverBanner(address)

Gets the MOTD banner URL of a Minecraft server.

• address: Server address (IP or domain)
• Returns: String URL of the server banner

Example Response

Server Status 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"
      }
    ]
  },
  "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>",
  "roundTripLatency": 43
}

License

MIT

Credits

This package uses the MCAPI.TR service. Check out their documentation for more information.