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.
Pass the server hosts and receive information about their status.
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.
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.
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.
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.
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.
Besides API call limitations per month, there are no other limitations.
Get the status of a server.
Get Server Status - Endpoint Features
Object | Description |
---|---|
Request Body |
[Required] Json |
{"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}}
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.
Bulk Server Status - Endpoint Features
Object | Description |
---|---|
Request Body |
[Required] Json |
[{"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"}}]
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
}
]
}'
Header | Description |
---|---|
Authorization
|
[Required] Should be Bearer access_key . See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
The "Get Server Status" endpoint returns real-time information about a single Minecraft server, including its online status, player count, and version details. The "Bulk Server Status" endpoint provides similar data for up to 100 servers simultaneously, allowing for efficient monitoring of multiple servers.
Key fields in the response include "host" (server address), "port" (connection port), "online" (server status), "players" (current and maximum player counts), and "version" (Minecraft version details). These fields help users assess server health and activity.
The response data is structured in JSON format. For individual server status, it includes a single object with server details. For bulk requests, it returns an array of objects, each containing the status of a different server, making it easy to parse and analyze.
Both endpoints provide server status (online/offline), player counts (current and maximum), and version information. The "Get Server Status" endpoint focuses on one server, while the "Bulk Server Status" endpoint aggregates data for multiple servers, enhancing monitoring capabilities.
The primary parameters for both endpoints are "host" (server address), "port" (connection port), and "type" (Java or Bedrock). Users can customize requests by specifying these parameters to target specific servers or server types.
Users can analyze the "online" status to determine server availability, use "players.online" to gauge activity levels, and check "version" for compatibility. This data helps server owners manage performance and players find active servers.
The data is sourced directly from the queried Minecraft servers. The API communicates with these servers to retrieve real-time status updates, ensuring that the information is current and accurate.
Data accuracy is maintained through direct queries to the servers, which provide live updates. The API's design ensures that it retrieves the latest information, allowing users to rely on the data for monitoring and decision-making.
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 1,000 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 1,000 requests per month, this header will display 1,000.
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 3,600, it means 3,600 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]
To give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.
After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, itβs important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.
Service Level:
100%
Response Time:
3,072ms
Service Level:
100%
Response Time:
10,814ms
Service Level:
100%
Response Time:
117ms
Service Level:
85%
Response Time:
454ms
Service Level:
100%
Response Time:
2,635ms
Service Level:
100%
Response Time:
1,116ms
Service Level:
100%
Response Time:
1,019ms
Service Level:
100%
Response Time:
341ms
Service Level:
100%
Response Time:
1,816ms
Service Level:
100%
Response Time:
686ms