BreakBlocks API Documentation

Overview Authentication Endpoints Rate Limiting Examples

API Overview

The BreakBlocks API provides developers with comprehensive tools to discover, monitor, and manage Minecraft servers. Whether you're building a server browser, monitoring tool, or game launcher, our API has you covered.

Quick Start

Get up and running in 5 steps:

  1. Choose Authentication: Use session-based auth for web apps or API keys for server-to-server communication
  2. Discover Servers: Use the /servers/find endpoint to search for Minecraft servers
  3. Check Status: Use /status/ping to monitor server health in real-time
  4. Get Metadata: Fetch game versions, countries, and regions supported by our platform
  5. Handle Limits: Be aware of rate limits and implement retry logic accordingly

Base URL

https://api.breakblocks.com/api/v0.1

Response Format

All responses are in JSON format with consistent structure:

{
  "success": true,
  "data": { /* endpoint-specific data */ },
  "message": "Operation completed successfully"
}

Quick Reference

Endpoint Method Description
/servers/find GET Discover servers with advanced filtering
/status/ping/:ip/:port GET Check real-time server status
/servers/versions GET List supported Minecraft versions
/servers/countries GET List available countries
/servers/regions GET List geographic regions
/user/apikeys GET Manage API keys

Example: Basic Server Discovery

Here's a simple curl request to discover servers in the United States:

curl -X GET "https://api.breakblocks.com/api/v0.1/servers/find?country=United%20States&limit=10" \
  -H "Accept: application/json"

API Key Authentication

For server-to-server requests, use an API key:

curl -X GET "https://api.breakblocks.com/api/v0.1/servers/find?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Support

For issues or questions, contact the development team using our contact form