BreakBlocks API Documentation

Comprehensive guides and references for building with the BreakBlocks Minecraft server API

Server Discovery

Find Minecraft servers with advanced filtering and search capabilities

Real-time Status

Monitor server health and player counts in real-time

Easy Integration

RESTful API with JSON responses and multiple authentication methods

High Performance

Fast, reliable API with generous rate limits for active users

Quick Start

  1. Read the Overview - Understand API basics and architecture
  2. Choose Authentication - Use sessions or API keys based on your needs
  3. Explore Endpoints - Review available endpoints and their parameters
  4. Check Rate Limits - Understand fair usage policies and throttling
  5. Code Examples - Reference code samples in Bash, JavaScript, and Python

Documentation Sections

API Overview

Get started with the BreakBlocks API. Learn the basics, authentication methods, base URL, response formats, and see your first example request.

Topics: Quick start, response format, endpoint reference, basic examples

View Overview

Authentication

Secure your API requests with session-based or API key authentication. Learn how to create, manage, and use API keys for your applications.

Topics: Sessions, API keys, creating keys, protected endpoints, error handling

View Authentication Guide

API Endpoints

Complete reference for all available API endpoints. Detailed documentation for server discovery, status monitoring, metadata retrieval, and user management.

Topics: Server discovery, status ping, metadata, user endpoints, parameters, response examples

View Endpoints

Rate Limiting

Understand rate limits and quotas. Learn how to handle throttling, implement retries, and optimize your requests for best performance.

Topics: Rate limit tiers, headers, retry logic, throttling, best practices

View Rate Limiting Guide

Code Examples

Production-ready code examples in multiple languages. See how to implement common patterns like server discovery, monitoring, and error handling.

Topics: Bash/cURL, JavaScript, Python, retry logic, caching, batch processing

View Code Examples

Need Help?

Can't find what you're looking for? Have questions or feedback about the API?

Contact Support

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

All endpoints return JSON. Authentication is optional for most endpoints but recommended for higher rate limits.