# Quaver Rhythm Game API
> Live player and ranking data from Quaver, the competitive vertical-scrolling rhythm game (VSRG, 4-key and 7-key), served from its public v2 API. The player endpoint resolves a user by id or username and returns the profile — country, clan, avatar, linked Twitch/Twitter and join date — together with the full per-mode competitive stats for both 4K and 7K: global and country rank, performance rating, overall accuracy, ranked and total score, play count and the grade distribution (SS/S/A/B/C/D). The search endpoint finds players by name. The leaderboard endpoint returns the global ranked ladder for a mode, with each player's rank, performance rating, accuracy and play count. This is a single-game competitive-community stats API — player profiles, ratings and ladders — distinct from the other rhythm-game and gaming-leaderboard APIs in the catalogue. Live, no key on the upstream, nothing stored.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/quaver-api/..."
```

## Pricing
- **Free** (Free) — 23,000 calls/Mo, 4 req/s
- **Starter** ($5/Mo) — 285,000 calls/Mo, 12 req/s
- **Pro** ($15/Mo) — 1,255,000 calls/Mo, 30 req/s
- **Scale** ($35/Mo) — 4,450,000 calls/Mo, 80 req/s

## Endpoints

### Players

#### `GET /v1/player` — Profile + 4K & 7K competitive stats

**Parameters:**
- `user` (query, required, string) — Quaver username or numeric id Example: `Swan`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/quaver-api/v1/player?user=Swan"
```

#### `GET /v1/search` — Find players by name

**Parameters:**
- `query` (query, required, string) — Name to search Example: `swan`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/quaver-api/v1/search?query=swan"
```

### Rankings

#### `GET /v1/leaderboard` — Global ranked ladder for a mode

**Parameters:**
- `mode` (query, optional, string) — Game mode: 4k or 7k Example: `4k`
- `page` (query, optional, string) — Page (50 per page) Example: `0`
- `limit` (query, optional, string) — Max rows (max 100) Example: `50`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/quaver-api/v1/leaderboard?mode=4k&page=0&limit=50"
```

### Meta

#### `GET /v1/meta` — Spec

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/quaver-api/v1/meta"
```


---
Marketplace page: https://www.oanor.com/api/quaver-api
OpenAPI spec: https://www.oanor.com/api/quaver-api/openapi.json