Skip to main content

Overview

The ScoreSaber Reloaded API is designed to be publicly accessible without authentication for most endpoints. This allows developers to easily integrate player profiles, scores, and leaderboard data into their applications.

Public Endpoints

Most API endpoints are public and do not require authentication:
  • Player profiles and statistics
  • Leaderboard data and scores
  • Score lookups and history
  • BeatSaver map information
  • Playlist data

Example Public Request

Protected Endpoints

Some administrative endpoints require authentication using Bearer tokens.

Metrics Endpoint

The /metrics endpoint exposes Prometheus metrics and requires authentication in production:
Authorization
string
required
Bearer token for authentication. Format: Bearer <token>

Example Request

Response

Returns Prometheus metrics in text format:
content-type
string
text/plain; version=0.0.4; charset=utf-8

Authentication Error

If the token is invalid or missing:

Request Headers

While authentication is not required for most endpoints, you can use these headers to customize API behavior:

Accept Header

Accept
string
default:"application/json"
Specify the response format. Options:
  • application/json - Standard JSON responses (default)
  • application/devalue - Optimized serialization format

Example with Devalue Format

CORS Support

The API includes CORS support for browser-based applications. All origins are allowed, making it easy to integrate the API into web applications:

Security Headers

The API uses the Helmet middleware for security:
  • DNS prefetch control enabled
  • Content Security Policy disabled for API flexibility
  • HSTS disabled (handled at reverse proxy level)

Example Requests

Fetch Player Profile

Search Leaderboards

Get Player Scores with Custom Format

Search Players

Get Score Details

Post Request with Friend IDs

Best Practices

  • Respect rate limits and implement exponential backoff for retries
  • Cache responses when appropriate to reduce API load
  • Use the /health endpoint for uptime monitoring
  • Monitor error responses and handle them gracefully
Do not attempt to authenticate with ScoreSaber credentials. The API proxies ScoreSaber data but does not require user authentication.