Minecraft Server Status API

Minecraft Server Status API

The Minecraft Server Status API allows users to retrieve information about Minecraft servers, including the number of players currently online, the server's message of the day (MOTD), and the server's status. This information is available for both Java and Bedrock servers.

API description

About the API:

The Minecraft Server Status API is a web-based application programming interface (API) that allows users to retrieve information about Minecraft servers. The API provides users with real-time updates on server status, player count, and other server-related details.

One of the primary features of the Minecraft Server Status API is the ability to retrieve the number of players currently online. This can be useful for server owners who want to keep track of their server's activity, or for players who want to find a server with a high player count. Additionally, the API allows users to retrieve information about the server's message of the day (MOTD), which can provide a brief description of the server's rules, features, or other important information.

Another important feature of the Minecraft Server Status API is the ability to check the server's status. This can be particularly useful for server owners who want to make sure that their server is up and running properly. If the API reports that the server is down, owners can quickly take action to address any issues and get the server back online.

The Minecraft Server Status API is available for both Java and Bedrock servers, making it a versatile tool for anyone who wants to retrieve information about Minecraft servers. In addition to the player count, MOTD, and status, the API also provides other server-related details, such as the server's IP address and port number.

Overall, the Minecraft Server Status API is a powerful tool for anyone who wants to retrieve information about Minecraft servers in real time. Whether you're a server owner, a player, or just someone who wants to stay up-to-date on the latest Minecraft server activity, the API provides a wealth of information that can help you stay informed and make informed decisions.

 

What this API receives and what your API provides (input/output)?

Pass the server hosts and receive information about their status. 

 

What are the most common uses cases of this API?

  1. Server owners can use the API to monitor the health and performance of their Minecraft servers in real time. By checking the server's status and player count, they can quickly identify any issues and take action to address them.

  2. Minecraft players can use the API to find servers with high player counts or specific game modes. By using the API to filter servers based on the player count or other criteria, they can quickly find servers that match their preferences.

  3. Developers can use the API to build custom applications or plugins that interact with Minecraft servers. For example, they could build a mobile app that displays real-time server status and player counts.

  4. Server hosts can use the API to monitor the performance of multiple Minecraft servers across different hosts. By tracking the status and player count of all their servers in one place, they can quickly identify any issues and take action to address them.

  5. Gaming communities can use the API to track the activity of multiple Minecraft servers at once. By using the API to monitor the player counts and status of all the servers in their community, they can identify trends and make informed decisions about which servers to promote or demote.

 

Are there any limitations to your plans?

Besides API call limitations per month, there are no other limitations. 

API Documentation

Endpoints


Get the status of a server. 



                                                                            
POST https://www.zylalabs.com/api/1916/minecraft+server+status+api/1622/get+server+status
                                                                            
                                                                        

Get Server Status - Endpoint Features
Object Description
Request Body [Required] Json
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"host":"mc.hypixel.net","port":25565,"type":"java","legacy":false,"online":true,"players":{"online":50171,"max":200000,"sample":[]},"version":{"name":"Requires MC 1.8 / 1.19","protocol":47},"request":{"host":"mc.hypixel.net","port":25565,"type":"java","legacy":false}}
                                                                                                                                                                                                                    
                                                                                                    

Get Server Status - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/1916/minecraft+server+status+api/1622/get+server+status' --header 'Authorization: Bearer YOUR_API_KEY' 

    

Request the server status of up to 100 servers at once.



                                                                            
POST https://www.zylalabs.com/api/1916/minecraft+server+status+api/1623/bulk+server+status
                                                                            
                                                                        

Bulk Server Status - Endpoint Features
Object Description
Request Body [Required] Json
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            [{"host":"bedrock.punchedmc.com","port":19132,"type":"bedrock","legacy":false,"online":false,"players":{"sample":[]},"version":{},"request":{"host":"bedrock.punchedmc.com","type":"bedrock","port":19132,"legacy":false}},{"host":"eu.mineplex.com","port":25565,"type":"java","legacy":false,"online":true,"players":{"online":69,"max":70,"sample":[]},"version":{"name":"Velocity 1.7.2-1.19.3","protocol":47},"request":{"host":"eu.mineplex.com","port":25565,"type":"java","legacy":false}},{"host":"mc.hypixel.net","port":25565,"type":"java","legacy":false,"online":true,"players":{"online":50171,"max":200000,"sample":[]},"version":{"name":"Requires MC 1.8 / 1.19","protocol":47},"request":{"host":"mc.hypixel.net","port":25565,"type":"java","legacy":false}},{"host":"tekkit.mc-complex.com","port":25565,"type":"java","legacy":true,"online":true,"players":{"online":32,"max":999,"sample":[]},"version":{"protocol":null},"request":{"host":"tekkit.mc-complex.com","legacy":true,"port":25565,"type":"java"}}]
                                                                                                                                                                                                                    
                                                                                                    

Bulk Server Status - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/1916/minecraft+server+status+api/1623/bulk+server+status' --header 'Authorization: Bearer YOUR_API_KEY' 

    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Minecraft Server Status API REST API, simply include your bearer token in the Authorization header.

Headers

Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.


Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

🚀 Enterprise
Starts at $10,000/Year

  • Custom Volume
  • Dedicated account manager
  • Service-level agreement (SLA)

Customer favorite features

  • ✔︎ Only Pay for Successful Requests
  • ✔︎ Free 7-Day Trial
  • ✔︎ Multi-Language Support
  • ✔︎ One API Key, All APIs.
  • ✔︎ Intuitive Dashboard
  • ✔︎ Comprehensive Error Handling
  • ✔︎ Developer-Friendly Docs
  • ✔︎ Postman Integration
  • ✔︎ Secure HTTPS Connections
  • ✔︎ Reliable Uptime

Zyla API Hub is, in other words, an API MarketPlace. An all-in-one solution for your developing needs. You will be accessing our extended list of APIs with only your user. Also, you won't need to worry about storing API keys, only one API key for all our products is needed.

Prices are listed in USD. We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble with paying by card, just contact us at [email protected]

Sometimes depending on the bank's fraud protection settings, a bank will decline the validation charge we make when we attempt to be sure a card is valid. We recommend first contacting your bank to see if they are blocking our charges. If more help is needed, please contact [email protected] and our team will investigate further

Prices are based on a recurring monthly subscription depending on the plan selected — plus overage fees applied when a developer exceeds a plan’s quota limits. In this example, you'll see the base plan amount as well as a quota limit of API requests. Be sure to notice the overage fee because you will be charged for each additional request.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

Just go to the pricing page of that API and select the plan that you want to upgrade to. You will only be charged the full amount of that plan, but you will be enjoying the features that the plan offers right away.

Yes, absolutely. If you want to cancel your plan, simply go to your account and cancel on the Billing page. Upgrades, downgrades, and cancellations are immediate.

You can contact us through our chat channel to receive immediate assistance. We are always online from 9 am to 6 pm (GMT+1). If you reach us after that time, we will be in contact when we are back. Also you can contact us via email to [email protected]