# Lichess on Onekey

> 10 endpoints for Lichess (10 stable, 0 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/lichess
Reference (Markdown): https://onekey.dev/docs/api/lichess.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `author.username` (string): 9
- `author.id` (string): 7
- `entity.stats.rating` (number): 5
- `author.verified` (boolean): 4
- `entity.id` (string): 3
- `author.url` (URL): 2
- `content.createdAt` (ISO 8601 date): 2
- `content.id` (string): 2
- `content.text` (string): 2
- `content.title` (string): 2
- `entity.description` (string): 2
- `entity.name` (string): 2
- `entity.stats.members` (integer): 2
- `author.avatarUrl` (URL): 1
- `author.displayName` (string): 1
- `content.language` (string): 1
- `entity.stats.rank` (integer): 1
- plus 22 platform-specific fields under `ext.`

## Endpoints

### lichess.daily_puzzle

Lichess daily puzzle.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/lichess/daily_puzzle` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.stats.rating`, `content.id`, `content.text`, `ext.plays`, `ext.perf`
- Reference: https://onekey.dev/docs/api/lichess/daily_puzzle.md

### lichess.leaderboard_blitz

Top 10 Lichess blitz players.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lichess/leaderboard_blitz` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.verified`, `entity.stats.rating`, `ext.title`, `ext.progress`
- Reference: https://onekey.dev/docs/api/lichess/leaderboard_blitz.md

### lichess.leaderboard_bullet

Top 10 Lichess bullet players.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lichess/leaderboard_bullet` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.verified`, `entity.stats.rating`, `ext.title`, `ext.progress`
- Reference: https://onekey.dev/docs/api/lichess/leaderboard_bullet.md

### lichess.leaderboard_rapid

Top 10 Lichess rapid players.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lichess/leaderboard_rapid` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.verified`, `entity.stats.rating`, `ext.title`, `ext.progress`
- Reference: https://onekey.dev/docs/api/lichess/leaderboard_rapid.md

### lichess.streamers_live

Lichess streamers that are live right now.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lichess/streamers_live` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `content.title`, `content.language`, `author.avatarUrl`, `author.url`
- Reference: https://onekey.dev/docs/api/lichess/streamers_live.md

### lichess.team

Fetch a Lichess team.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/lichess/team?team=lichess-swiss` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `team` (string, required): Team id, e.g. lichess-swiss
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.stats.members`, `author.id`, `author.username`, `ext.open`
- Reference: https://onekey.dev/docs/api/lichess/team.md

### lichess.team_search

Search Lichess teams by name.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lichess/team_search?q=chess` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.stats.members`, `author.id`, `author.username`
- Reference: https://onekey.dev/docs/api/lichess/team_search.md

### lichess.tournaments

Currently running Lichess arena tournaments.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/lichess/tournaments` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `author.username`, `content.createdAt`, `ext.players`, `ext.minutes`, `ext.variant`, `ext.rated`
- Reference: https://onekey.dev/docs/api/lichess/tournaments.md

### lichess.user

Fetch a Lichess user's public profile and ratings.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/lichess/user?username=DrNykterstein` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Lichess username, e.g. DrNykterstein
- Fields returned: `author.id`, `author.username`, `content.text`, `author.displayName`, `author.url`, `content.createdAt`, `author.verified`, `ext.title`, `ext.games`, `ext.wins`, `ext.losses`, `ext.draws`, `ext.bullet`, `ext.blitz`, `ext.rapid`, `ext.classical`, `ext.playTimeSeconds`
- Reference: https://onekey.dev/docs/api/lichess/user.md

### lichess.user_perf

Fetch a Lichess user's statistics for one game mode.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/lichess/user_perf?username=DrNykterstein&perf=blitz` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Lichess username, e.g. DrNykterstein
  - `perf` (string, required): Game mode
- Fields returned: `author.username`, `entity.stats.rating`, `entity.stats.rank`, `ext.deviation`, `ext.games`, `ext.progress`, `ext.percentile`, `ext.highest`, `ext.lowest`
- Reference: https://onekey.dev/docs/api/lichess/user_perf.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/lichess/daily_puzzle" \
  -H "x-api-key: YOUR_API_KEY"
```