arrow_back Back

API Documentation

Public JSON API for stats and leaderboard data

info Overview

The Fedle API exposes statistics and leaderboard data for third-party consumption (dashboards, bots, widgets). The game itself is played entirely via ActivityPub, not via this API.

lock_open Authentication

No authentication required. Rate limited to 60 requests per minute per IP.

api Endpoints

GET
/api/v1/stats

Global statistics: total players, followers, games, current game number.

Response:
 "players": 142, "followers": 138, "games": 4280, "currentGame": 42 
GET
/api/v1/leaderboard

Instance leaderboard ranked by average attempts.

Parameters:
  • days — Period in days (default: 7)
  • limit — Max results (default: 20, max: 50)
Response:
[ "instance": "fosstodon.org", "playerCount": 14, "avgAttempts": 3.2, "winRate": 91 ]
GET
/api/v1/history

Past puzzles with basic stats.

Parameters:
  • page — Page number (default: 1)
  • limit — Results per page (default: 20, max: 50)
GET
/api/v1/game/:id

Single puzzle stats: outcome distribution, average attempts, win rate.

GET
/api/v1/instance/:domain

Stats for a specific instance: player count, average attempts, win rate.

Parameters:
  • days — Period in days (default: 7)