API Documentation

Complete reference for the Anisu! API

Endpoints
Search Beatmaps
GET
/api/search

Search for beatmaps with various filters

Parameters
Request parameters for this endpoint
q
Required
string

Search query

mode
Optional
string

Game mode (osu, taiko, fruits, mania)

status
Optional
string

Beatmap status (ranked, qualified, etc.)

sort
Optional
string

Sort by (title, artist, bpm, etc.)

order
Optional
string

Sort order (asc, desc)

Rate Limiting
Requests per hour1,000
Burst limit100 per minute
Rate limit headersIncluded

Rate limits are applied per IP address. Headers include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Error Handling
200
Success
400
Bad Request - Invalid parameters
404
Not Found - Resource doesn't exist
429
Too Many Requests - Rate limited
500
Internal Server Error

All errors return JSON with an error message and appropriate HTTP status code.