LEADR API Documentation¶

Welcome to the LEADR API documentation.

Documentation Sections¶

Python API Reference ¶

Complete reference for all Python modules, classes, and functions in the LEADR codebase. Auto-generated from docstrings using griffe2md and organized by module.

Architecture Patterns ¶

Comprehensive guide to the Domain-Driven Design patterns and best practices used throughout the LEADR codebase.

HTTP API Reference ¶

Complete REST API documentation for all HTTP endpoints. Auto-generated from the FastAPI application's OpenAPI specification and organized by resource.

Quick Links¶

About LEADR¶

LEADR is a cross-platform leaderboard backend for indie game developers. It's an open-source FastAPI-based REST API that provides leaderboard functionality with features like:

Multi-tenant account management
Flexible leaderboard configurations
Score tracking with metadata
API key authentication
Beautiful web views
Anti-cheat protection (planned)
Season support (planned)

Development¶

For information about contributing to LEADR, setting up your development environment, and understanding the codebase architecture, please refer to:

Project README for quick start
CLAUDE.md for AI assistant guidance
patterns.md for architectural patterns
Python API Reference (this documentation) for code details

Last updated: Auto-generated on release