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.

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://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":40295,"max":200000,"sample":[]},"version":{"name":"Requires MC 1.8 / 1.21","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' 

--data-raw '{
    "host": "mc.hypixel.net"
}'

    

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



                                                                            
POST https://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' 

--data-raw '{
    "hosts": [
        {
            "host": "mc.hypixel.net"
        },
        {
            "host": "eu.mineplex.com",
            "port": 25565,
            "type": "java",
            "legacy": false
        },
        {
            "host": "bedrock.punchedmc.com",
            "type": "bedrock"
        },
        {
            "host": "tekkit.mc-complex.com",
            "legacy": true
        }
    ]
}'

    

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
  • Specialized Customer Support
  • Real-Time API Monitoring

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 like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). 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 paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

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.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, refer to the β€˜X-Zyla-API-Calls-Monthly-Remaining’ field in the response header. For example, if your plan allows 1000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ response header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

The β€˜X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3600, it means 3600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]


Related APIs