πŸ“Š API Documentation

Leaderboard

GET /api/leaderboard

  • page – page number (default: 1)
  • country – country codes (comma-separated)
  • date – snapshot date (default: 2025-03-10)
  • page_size – results per page (1–100)

{ scores: [...], page: 1, total: 1200 }

Leaderboard Map History

GET /api/past_map_stats

  • map – leaderboard ID
  • player – player ID (optional)

{ scores: [...], map_data: {...}, player_data?: {...} }

Player History

GET /api/past_player_stats

  • player – player ID

{ past_pp: [...], past_rank: [...], ... }

Player Scores

GET /api/player_scores

  • player – player ID
  • page – page number
  • date – snapshot date
  • sort – one of: pp, score, accuracy, max_combo, bad_cuts_or_misses, hardest, recent
  • reverse – true/false
  • only_ranked – true/false
  • page_size – results per page (1–100)

{ scores: [...] }

Search Players

GET /api/search

  • text – search query
  • page – page number
  • page_size – results per page

{ players: [...] }'

Embeds

GET /profile/[player_id]

Description: Embeds a compact view of a player's stats, score history, and progression graph.

  • compact – true to enable embed mode
  • scores – true/false to show top scores
  • scores_sort – one of: recent, recent-duplicated, hardest, accuracy, max_combo, bad_cuts_or_misses, score, pp (default)
  • only_ranked – true/false to hide unranked scores
  • score_count – number of scores to show (1–100)
  • graph – true/false to show performance graph
  • settings – true/false to show settings like score page or sort

Renders an embeddable component of player history and optionally scores/settings.

Example:
/profile/3225556157461414?compact=true&scores=true&scores_sort=recent&graph=true&settings=true&only_ranked=true&score_count=5

GET /score-improvement/[map_id]/[player_id?]

Description: Displays score improvements on a specific map. With player_id, shows that player's top scores. Without it, shows top scores across all players.

  • compact – true for embed mode

Embeds player or global top improvements on the specified map.

Examples:

  • /score-improvement/636520/1922350521131465?compact=true – Player’s score progress on map
  • /score-improvement/636520?compact=true – Global top scores on map