REST API

RefleK's API

A production Go monolith that powers run archiving, benchmarks, leaderboards, and scenario data for the RefleK's platform.

What is RefleK's API?

The RefleK's API is a production-oriented Go monolith that backs the RefleK's platform. It handles run sync from the desktop app, serves benchmark and leaderboard data, and exposes scenario and player browsing endpoints, all backed by Postgres and Cloudflare R2.

Built for long-term maintainability with structured logging, middleware-ready HTTP, and graceful shutdown. The endpoints are publicly available and ready for integration with no authentication required for core read and download operations.

API terminal output showing request handling

What's Available

The API exposes a rich set of endpoints for the RefleK's ecosystem.

Run Archive

Browse and download raw .refleks run files with full metadata, mouse traces, and player details.

Benchmarks & Leaderboards

Full benchmark hierarchy browsing with rank thresholds, scenario links, and per-scenario and per-difficulty leaderboard endpoints.

Scenario Browser

Searchable, sortable scenarios with run counts, score distributions, and sensitivity distributions for deep population-level analysis.

Player Browser

Search and sort players by username or Steam ID with run counts and last activity timestamps.

Status & Stats

Health check endpoint and aggregate database statistics including total runs, players, and scenarios at a glance.

Full Documentation

Every endpoint, configuration option, and response format is documented in the repository README on GitHub.

Open Source

RefleK's API is licensed under AGPL-3.0. The full source, endpoint reference, and configuration guide are available on GitHub.

View on GitHub