Introduction
The ScoreSaber Reloaded API is a REST API built with Elysia that provides programmatic access to player profiles, scores, leaderboards, and statistics. The API uses OpenAPI specifications and is available at/swagger for interactive documentation.
Base URL
The API is available at:Response Format
The API supports multiple response formats based on theAccept header:
JSON (Default)
All endpoints return JSON by default:application/jsonDevalue Format
For optimized data serialization, send theAccept: application/devalue header:
application/devalueError Handling
The API uses standard HTTP status codes and returns structured error responses.Error Response Format
All errors follow this structure:HTTP status code (400, 404, 429, 500, etc.)
Human-readable error message describing what went wrong
ISO 8601 timestamp when the error occurred
Common Status Codes
Request completed successfully
Invalid request parameters or malformed request body
The requested resource (player, leaderboard, score) was not found
Rate limit exceeded - slow down your requests
An unexpected error occurred on the server
Example Error Response
Validation Errors
Validation errors (400 status) return an array of validation issues:Rate Limits
The API implements rate limiting to ensure fair usage and system stability. When the rate limit is exceeded, the API returns a429 Too Many Requests status code.
Rate limits are monitored and adjusted dynamically. The API tracks ScoreSaber’s rate limit headers (
x-ratelimit-remaining) when proxying requests.Rate Limit Response
OpenAPI Documentation
Interactive API documentation is available at:- Complete endpoint listing with parameters
- Request/response schemas
- Try-it-out functionality
- Type definitions and examples
Health Check
Verify the API is operational:API Statistics
Get backend statistics:- Total players tracked
- Total scores stored
- Database statistics
- Cache metrics