Home

Welcome to the Statfyr Wiki

Statfyr is a lightweight Paper plugin that exposes your Minecraft server's player statistics through a clean, fully-documented REST API. Build dashboards, leaderboard websites, Discord bots, or any external integration — all against a single HTTP endpoint, in any language.

---

📚 Wiki Contents

Page	Description
Installation	How to install and set up Statfyr
Configuration	Full config reference with every option explained
API Reference	All endpoints, parameters, and response schemas
Authentication & Security	API keys, HTTPS, CORS, IP whitelisting
Rate Limiting	How rate limiting works and how to configure it
Caching	Response caching behaviour and tuning
Commands & Permissions	In-game commands and permission nodes
Troubleshooting	Common problems and how to fix them
Changelog	Version history

---

⚡ Quick Start

1. Drop the jar into /plugins/

2. Start your server — Statfyr generates its config automatically.

3. Hit the API:

GET http://your-server-ip:8080/api/health

4. You should see:

{
  "status": "ok",
  "plugin_version": "1.0.0-BETA",
  "minecraft_version": "1.21.10",
  "online_players": 3,
  "uptime_seconds": 120
}

That's it. The API is live.

---

🔗 Links

• Modrinth
• GitHub