# osu! on Onekey

> 2 endpoints for osu! (0 stable, 2 beta), 1 to 5 credits each. Category: Gaming. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/osu
Reference (Markdown): https://onekey.dev/docs/api/osu.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 2 mapped osu! endpoints return each:

- `author.username` (string): 2
- `content.createdAt` (ISO 8601 date): 2
- `author.avatarUrl` (URL): 1
- `author.id` (string): 1
- `engagement.likes` (integer): 1
- `entity.country` (string): 1
- `entity.id` (string): 1
- `entity.name` (string): 1
- `entity.status` (string): 1
- `media.thumbnailUrl` (URL): 1
- plus 6 platform-specific fields under `ext.`

## Endpoints

### osu.beatmapset_search

Search osu! beatmap sets.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/osu/beatmapset_search?q=freedom%20dive` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
- Fields returned: `entity.id`, `entity.name`, `author.username`, `engagement.likes`, `entity.status`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`, `ext.plays`
- Reference: https://onekey.dev/docs/api/osu/beatmapset_search.md

### osu.user

Fetch an osu! player (standard mode).
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/osu/user?user=peppy` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): osu! user id or username
- Fields returned: `author.id`, `author.username`, `author.avatarUrl`, `content.createdAt`, `entity.country`, `ext.pp`, `ext.globalRank`, `ext.accuracy`, `ext.plays`, `ext.level`
- Reference: https://onekey.dev/docs/api/osu/user.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/osu/user?user=peppy" \
  -H "x-api-key: YOUR_API_KEY"
```