# Chess on Onekey

> 16 endpoints for Chess (16 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/chess
Reference (Markdown): https://onekey.dev/docs/api/chess.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `author.username` (string): 8
- `author.avatarUrl` (URL): 7
- `author.url` (URL): 7
- `content.createdAt` (ISO 8601 date): 7
- `author.displayName` (string): 6
- `author.id` (string): 6
- `entity.url` (URL): 6
- `entity.stats.rank` (integer): 5
- `entity.stats.score` (number): 5
- `media.thumbnailUrl` (URL): 4
- `content.title` (string): 3
- `content.url` (URL): 3
- `entity.name` (string): 3
- `entity.status` (string): 3
- `content.text` (string): 2
- `entity.id` (string): 2
- `entity.type` (string): 2
- `entity.updatedAt` (ISO 8601 date): 2
- `author.followers` (integer): 1
- `author.verified` (boolean): 1
- `entity.description` (string): 1
- `entity.location` (string): 1
- `entity.stats.members` (integer): 1
- plus 25 platform-specific fields under `ext.`

## Endpoints

### chess.club

Fetch a Chess.com club's public profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/chess/club?club=chess-com-developer-community` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `club` (string, required): Club URL id, e.g. chess-com-developer-community
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `media.thumbnailUrl`, `entity.stats.members`, `content.createdAt`, `entity.updatedAt`, `ext.averageDailyRating`
- Reference: https://onekey.dev/docs/api/chess/club.md

### chess.club_matches

List a Chess.com club's finished team matches.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/club_matches?club=chess-com-developer-community` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `club` (string, required): Club URL id, e.g. chess-com-developer-community
- Fields returned: `entity.name`, `entity.url`, `content.createdAt`, `ext.opponent`, `ext.timeClass`, `ext.result`
- Reference: https://onekey.dev/docs/api/chess/club_matches.md

### chess.daily_puzzle

Chess.com's daily puzzle.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/chess/daily_puzzle` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.title`, `content.url`, `content.createdAt`, `content.text`, `media.thumbnailUrl`, `ext.fen`
- Reference: https://onekey.dev/docs/api/chess/daily_puzzle.md

### chess.game_archives

List the monthly game-archive URLs of a Chess.com player.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/game_archives?username=hikaru` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Chess.com username, e.g. hikaru
- Fields returned: `entity.url`
- Reference: https://onekey.dev/docs/api/chess/game_archives.md

### chess.leaderboard_blitz

Top 50 Chess.com blitz leaderboard.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/leaderboard_blitz` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.url`, `author.avatarUrl`, `entity.stats.score`, `entity.stats.rank`, `ext.wins`, `ext.losses`, `ext.title`
- Reference: https://onekey.dev/docs/api/chess/leaderboard_blitz.md

### chess.leaderboard_bullet

Top 50 Chess.com bullet leaderboard.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/leaderboard_bullet` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.url`, `author.avatarUrl`, `entity.stats.score`, `entity.stats.rank`, `ext.wins`, `ext.losses`, `ext.title`
- Reference: https://onekey.dev/docs/api/chess/leaderboard_bullet.md

### chess.leaderboard_daily

Top 50 Chess.com daily leaderboard.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/leaderboard_daily` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.url`, `author.avatarUrl`, `entity.stats.score`, `entity.stats.rank`, `ext.wins`, `ext.losses`, `ext.title`
- Reference: https://onekey.dev/docs/api/chess/leaderboard_daily.md

### chess.leaderboard_rapid

Top 50 Chess.com rapid leaderboard.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/leaderboard_rapid` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.url`, `author.avatarUrl`, `entity.stats.score`, `entity.stats.rank`, `ext.wins`, `ext.losses`, `ext.title`
- Reference: https://onekey.dev/docs/api/chess/leaderboard_rapid.md

### chess.leaderboard_tactics

Top 50 Chess.com tactics leaderboard.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/leaderboard_tactics` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.url`, `author.avatarUrl`, `entity.stats.score`, `entity.stats.rank`, `ext.wins`, `ext.losses`, `ext.title`
- Reference: https://onekey.dev/docs/api/chess/leaderboard_tactics.md

### chess.player_clubs

List the clubs a Chess.com player belongs to.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/player_clubs?username=hikaru` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Chess.com username, e.g. hikaru
- Fields returned: `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `entity.updatedAt`
- Reference: https://onekey.dev/docs/api/chess/player_clubs.md

### chess.player_tournaments

List the tournaments a Chess.com player has finished.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/player_tournaments?username=hikaru` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Chess.com username, e.g. hikaru
- Fields returned: `entity.url`, `entity.id`, `entity.type`, `entity.status`, `ext.placement`, `ext.wins`, `ext.losses`, `ext.draws`, `ext.players`, `ext.timeClass`
- Reference: https://onekey.dev/docs/api/chess/player_tournaments.md

### chess.profile

Fetch a Chess.com player's public profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/chess/profile?username=hikaru` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Chess.com username, e.g. hikaru
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.followers`, `author.url`, `author.avatarUrl`, `author.verified`, `content.createdAt`, `entity.status`, `entity.location`, `ext.title`, `ext.league`, `ext.lastOnline`
- Reference: https://onekey.dev/docs/api/chess/profile.md

### chess.random_puzzle

A random Chess.com daily-puzzle from the archive.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/chess/random_puzzle` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.title`, `content.url`, `content.createdAt`, `content.text`, `media.thumbnailUrl`, `ext.fen`
- Reference: https://onekey.dev/docs/api/chess/random_puzzle.md

### chess.stats

Fetch a Chess.com player's ratings and W/L/D records per time control.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/chess/stats?username=hikaru` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `username` (string, required): Chess.com username, e.g. hikaru
- Fields returned: `ext.rapid`, `ext.blitz`, `ext.bullet`, `ext.daily`, `ext.fide`, `ext.tacticsBest`, `ext.puzzleRushBest`, `ext.blitzWins`, `ext.blitzLosses`, `ext.blitzDraws`
- Reference: https://onekey.dev/docs/api/chess/stats.md

### chess.streamers

Chess.com streamers and whether they are live.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/chess/streamers` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `author.username`, `author.url`, `author.avatarUrl`, `entity.url`, `ext.live`
- Reference: https://onekey.dev/docs/api/chess/streamers.md

### chess.tournament

Fetch a Chess.com tournament.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/chess/tournament?tournament=-masterclass-titled-tuesday-blitz-862996` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `tournament` (string, required): Tournament URL id
- Fields returned: `content.title`, `content.url`, `author.username`, `entity.status`, `content.createdAt`, `entity.type`, `ext.timeClass`, `ext.players`, `ext.rounds`
- Reference: https://onekey.dev/docs/api/chess/tournament.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/chess/club?club=chess-com-developer-community" \
  -H "x-api-key: YOUR_API_KEY"
```