Information
- OpenAPI version:
3.1.0
Overview
McQuery API 1.0.0
Section titled “McQuery API 1.0.0”This is the API that powers mcquery.net. It accepts a Minecraft server address and it resolves the host, pings the server, and reports back everything the server advertises. It works with both Java and Bedrock editions servers.
Base URL
Every endpoint is under https://api.mcquery.net and is a plain GET request with URL query parameters.
Authentication and limits
The API is public and free to use, so no API key is needed. It is rate limited to 120 requests per minute per client IP. Every response carries the standard RateLimit/RateLimit-* headers reporting your remaining budget, and exceeding the limit returns a 429 with a Retry-After header. Results are briefly cached for 5 seconds, and flagged by the cached field in each response.
Do note that you can get banned from using the API if at any point I don’t like the requests that you’re sending.
Responses
The JSON endpoints always return an ok boolean. When ok is true the server’s status fields are returned alongside connection and DNS metadata. When it is false, msg explains what went wrong. Targets that resolve to a private or reserved address are refused. Cross-origin requests are allowed, so these endpoints can be called directly from the browser.