{"info":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","description":"

♟️ Chess Match Analytics API

Welcome to the Chess Match Analytics API — a complete backend API for storing, managing, and deeply analyzing chess matches. Whether you're building a chess platform, studying game patterns, or exploring chess statistics, this API covers everything from basic match CRUD to advanced analytics, player profiles, opening theory, and admin controls.

🌐 Base URL

https://chess-game-dataset-harshit-kumar.onrender.com/api/v1\n

\n
Set the baseUrl variable in your Postman environment to your server address, for example: http://localhost:3000
\n

🔐 Authentication

This API uses JWT (JSON Web Token) Bearer authentication.

How it works:

Register a new account or log in with existing credentials.
You'll receive a token in the response.
This token must be sent with every protected request in the Authorization header:

Authorization: Bearer <your_token_here>\n

The collection is already configured to use {{json_web_token_0tq4}} as the Bearer token. Just set this variable in your environment after logging in and all protected requests will work automatically.

🚀 Getting Started

Follow these steps to start using the API:

Step 1 — Register → Send a POST request to /api/v1/auth/register with your username, email, and password.

Step 2 — Login → Send a POST request to /api/v1/auth/login with your credentials. Copy the token from the response.

Step 3 — Save your token → Set the json_web_token_0tq4 variable in your Postman environment to the token value.

Step 4 — Explore → You're ready! Start with GET /api/v1/matches to browse chess matches.

📁 Folder Overview

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Folder	Description
Auth	Register, login, and view your profile
Matches	Full CRUD for chess matches — create, read, update, delete, filter, sort, bulk operations
Search	Search matches, players, openings, ECO codes, moves, and more
Analytics	Deep analytics — victory distribution, rating upsets, time control usage, hourly activity
Stats	Quick stats — total matches, win rates, draw rates, top openings
System	Server health, uptime, logs, config, performance metrics
Players	Player profiles, stats, win/loss/draw rates, rating history, comparisons
Openings Theory	Browse chess openings — popular, aggressive, defensive, gambits, by ECO code
Admin & Middleware	Admin-only routes — manage users, clear cache, view logs, middleware inspection
Pagination	Examples of standard, cursor-based, and infinite scroll pagination
Sorting	Examples of sorting matches by date, rating, move count, duration, and more
HEAD & OPTIONS	HTTP HEAD and OPTIONS requests for checking headers and CORS preflight

📦 Match Object Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique match identifier
`white`	string	Username of the white player
`black`	string	Username of the black player
`winner`	string	`\"white\"`, `\"black\"`, or `\"draw\"`
`termination`	string	How the game ended: `\"checkmate\"`, `\"resignation\"`, `\"timeout\"`, `\"draw\"`
`opening`	string	Name of the opening played
`eco`	string	ECO code of the opening (e.g., `B20`)
`moves`	number	Total number of moves in the game
`rated`	boolean	Whether the game was rated
`timeControl`	string	Time control: `\"bullet\"`, `\"blitz\"`, `\"rapid\"`, `\"classical\"`
`whiteRating`	number	Elo rating of the white player
`blackRating`	number	Elo rating of the black player
`pgn`	string	Full PGN notation of the game
`fen`	string	Final FEN position of the game
`createdAt`	string	ISO timestamp of when the match was recorded

💡 Tips

All list endpoints support ?page=1&limit=10 for pagination.
Filter endpoints use dedicated routes like /matches/filter/blitz.
Sorting endpoints use query params like ?sort=moves&order=desc.
Admin routes require a valid JWT token with admin privileges.
Use the HEAD method to check if a resource exists without downloading the full response body.
Use the OPTIONS method to check which HTTP methods are allowed on an endpoint (useful for CORS).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"♟️ Chess Match Analytics API","slug":"chess-match-analytics-api"}],"owner":"50839854","collectionId":"d095997f-866b-41ee-91f4-a38e92f51650","publishedId":"2sBXwtqpxw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-17T18:06:28.000Z"},"item":[{"name":"Auth","item":[{"name":"Register","id":"fc9a3e36-777d-4e64-be91-e767b6047a6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"testuser1\",\n \"email\": \"test1@example.com\",\n \"password\": \"password123\"\n}"},"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/auth/register","description":"

Register a New Account

Creates a new user account. This is the first step before you can log in and access protected endpoints.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/auth/register\nAuth Required: No

Request Body (JSON)

{\n  \"username\": \"harshit\",\n  \"email\": \"harshit@example.com\",\n  \"password\": \"yourpassword123\"\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Description
`username`	✅	Your unique display name
`email`	✅	A valid email address
`password`	✅	A secure password

Response

201 Created — Account created successfully.

{\n  \"message\": \"User registered successfully\",\n  \"userId\": \"abc123\"\n}\n

400 Bad Request — Missing fields or email already in use.

Authenticates a user and returns a JWT token. You must save this token and use it in the Authorization header for all protected requests.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/auth/login\nAuth Required: No

Request Body (JSON)

{\n  \"email\": \"harshit@example.com\",\n  \"password\": \"yourpassword123\"\n}\n

Response

200 OK — Login successful. Copy the token value.

{\n  \"message\": \"Login successful\",\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n

401 Unauthorized — Invalid email or password.

\n
💡 After logging in, set the json_web_token_0tq4 environment variable to the token value. All protected requests in this collection will then work automatically.
\n

Get My Profile

Returns the profile of the currently logged-in user based on the JWT token provided.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/auth/profile\nAuth Required: Yes (Bearer Token)

Response

200 OK — Returns the authenticated user's profile.

{\n  \"id\": \"abc123\",\n  \"username\": \"harshit\",\n  \"email\": \"harshit@example.com\",\n  \"createdAt\": \"2024-01-01T00:00:00Z\"\n}\n

401 Unauthorized — Token is missing or invalid.

\n","urlObject":{"path":["api","v1","auth","profile"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"16cc2950-1fa5-4041-a35a-5f6a5db0ffa2"}],"id":"cdf4041e-67f6-4379-bb36-39fe16623c45","_postman_id":"cdf4041e-67f6-4379-bb36-39fe16623c45","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"Matches","item":[{"name":"Get Matches","id":"1ceb515e-0bd4-44bf-af9b-570ffe61585b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches?page=1&limit=10","description":"

Get All Matches

Returns a paginated list of all chess matches stored in the database.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches?page=1&limit=10\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`page`	number	Page number to retrieve (default: 1)
`limit`	number	Number of results per page (default: 10)

Response

200 OK — Returns a list of matches.

{\n  \"matches\": [\n    {\n      \"id\": \"TZJHLljE\",\n      \"white\": \"magnus\",\n      \"black\": \"hikaru\",\n      \"winner\": \"white\",\n      \"moves\": 42,\n      \"opening\": \"Sicilian Defense\"\n    }\n  ],\n  \"total\": 1500,\n  \"page\": 1,\n  \"limit\": 10\n}\n

Get Match By ID

Returns the full details of a single chess match by its unique ID.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/TZJHLljE\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The unique ID of the match (e.g., `TZJHLljE`)

Response

200 OK — Returns the full match object.

{\n  \"id\": \"TZJHLljE\",\n  \"white\": \"magnus\",\n  \"black\": \"hikaru\",\n  \"winner\": \"white\",\n  \"termination\": \"resignation\",\n  \"opening\": \"Sicilian Defense\",\n  \"eco\": \"B20\",\n  \"moves\": 42,\n  \"rated\": true,\n  \"timeControl\": \"blitz\",\n  \"whiteRating\": 2850,\n  \"blackRating\": 2780\n}\n

404 Not Found — No match found with the given ID.

Create a New Match

Adds a new chess match to the database. Use this to record a game that was played.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches\nAuth Required: Yes (Bearer Token)

Request Body (JSON)

{\n  \"white\": \"magnus\",\n  \"black\": \"hikaru\",\n  \"winner\": \"white\",\n  \"termination\": \"resignation\",\n  \"opening\": \"Sicilian Defense\",\n  \"eco\": \"B20\",\n  \"moves\": 42,\n  \"rated\": true,\n  \"timeControl\": \"blitz\",\n  \"whiteRating\": 2850,\n  \"blackRating\": 2780,\n  \"pgn\": \"1.e4 c5 2.Nf3 ...\",\n  \"fen\": \"rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR\"\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Description
`white`	✅	Username of the white player
`black`	✅	Username of the black player
`winner`	✅	`\"white\"`, `\"black\"`, or `\"draw\"`
`termination`	✅	How the game ended
`moves`	✅	Total number of moves
`rated`	✅	Whether the game was rated
`timeControl`	✅	`\"bullet\"`, `\"blitz\"`, `\"rapid\"`, or `\"classical\"`

Response

201 Created — Match saved successfully.

400 Bad Request — Missing or invalid fields.

\n","urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"523f1367-405e-431d-b3c2-176f51d212da"},{"name":"Update Match","id":"cf03b1bd-c497-4aa8-8bf9-b9be15fcb821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{auth_secret_0tq4}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN_HERE"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"victory_status\": \"resign\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/test1234","description":"

Update a Match

Updates one or more fields of an existing chess match. Only the fields you include in the request body will be changed.

Method: PATCH\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/test1234\nAuth Required: Yes (Bearer Token)

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The ID of the match to update (e.g., `test1234`)

Request Body (JSON) — send only the fields you want to update

{\n  \"winner\": \"black\",\n  \"termination\": \"checkmate\"\n}\n

Response

200 OK — Match updated successfully.

404 Not Found — Match with the given ID does not exist.

\n","urlObject":{"path":["api","v1","matches","test1234"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf03b1bd-c497-4aa8-8bf9-b9be15fcb821"},{"name":"Delete Match","id":"c3e04fdb-ea85-4124-a619-f911c85b61ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN_HERE"}],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/test1234","description":"

Delete a Match

Permanently deletes a chess match from the database by its ID. This action cannot be undone.

Method: DELETE\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/test1234\nAuth Required: Yes (Bearer Token)

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The ID of the match to delete (e.g., `test1234`)

Response

200 OK — Match deleted successfully.

404 Not Found — Match with the given ID does not exist.

\n
⚠️ This permanently removes the match. Consider using Archive Match if you want to hide it without deleting.
\n

\n","urlObject":{"path":["api","v1","matches","test1234"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3e04fdb-ea85-4124-a619-f911c85b61ed"},{"name":"Filter Rated","id":"36f35397-2273-42f5-b3be-8a57385d5240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/rated","description":"

Filter Rated Matches

Returns only rated matches — games where both players' Elo ratings were affected by the result.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/rated\nAuth Required: No

Response

200 OK — Returns a list of rated matches.

Filter Unrated Matches

Returns only unrated (casual) matches — games played for fun where ratings were not affected.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/unrated\nAuth Required: No

Response

200 OK — Returns a list of unrated matches.

Filter White Wins

Returns only matches where white won the game.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/white-wins\nAuth Required: No

Response

200 OK — Returns a list of matches won by white.

Filter Black Wins

Returns only matches where black won the game.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/black-wins\nAuth Required: No

Response

200 OK — Returns a list of matches won by black.

Filter Checkmates

Returns only matches that ended in checkmate — where one player's king was put in an inescapable check.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/checkmates\nAuth Required: No

Response

200 OK — Returns a list of matches that ended by checkmate.

Sort by Longest Games

Returns matches sorted by move count in descending order — the longest games appear first.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/longest\nAuth Required: No

Response

200 OK — Returns matches sorted from most moves to fewest.

Sort by Shortest Games

Returns matches sorted by move count in ascending order — the shortest games appear first.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/shortest\nAuth Required: No

Response

200 OK — Returns matches sorted from fewest moves to most.

Sort by Highest Rated

Returns matches sorted by the combined player rating in descending order — the highest-rated games appear first.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/highest-rated\nAuth Required: No

Response

200 OK — Returns matches sorted by combined rating (highest first).

Get Match Moves

Returns the full list of moves played in a specific match, in order.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/moves\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The unique ID of the match

Response

200 OK — Returns an ordered list of moves.

{\n  \"matchId\": \"TZJHLljE\",\n  \"moves\": [\"e4\", \"c5\", \"Nf3\", \"d6\", \"d4\", \"cxd4\"]\n}\n

404 Not Found — Match not found.

Get Match PGN

Returns the PGN (Portable Game Notation) of a specific match. PGN is the standard format for recording chess games and can be imported into any chess software.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/pgn\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The unique ID of the match

Response

200 OK — Returns the PGN string.

{\n  \"matchId\": \"TZJHLljE\",\n  \"pgn\": \"[Event \\\"Blitz\\\"]\\n[White \\\"magnus\\\"]\\n[Black \\\"hikaru\\\"]\\n1.e4 c5 2.Nf3 d6 ...\"\n}\n

404 Not Found — Match not found.

Get Match FEN

Returns the FEN (Forsyth-Edwards Notation) of the final board position of a specific match. FEN is a compact way to describe a chess board state.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/fen\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The unique ID of the match

Response

200 OK — Returns the FEN string of the final position.

{\n  \"matchId\": \"TZJHLljE\",\n  \"fen\": \"rnbqkb1r/pp2pppp/3p1n2/2p5/3PP3/5N2/PPP2PPP/RNBQKB1R w KQkq - 0 4\"\n}\n

404 Not Found — Match not found.

Get Match Engine Analysis

Returns a computer engine analysis of a specific match — including move evaluations, blunders, mistakes, and inaccuracies for both players.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/analysis\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The unique ID of the match

Response

200 OK — Returns the engine analysis report.

{\n  \"matchId\": \"TZJHLljE\",\n  \"white\": {\n    \"accuracy\": 91.2,\n    \"blunders\": 0,\n    \"mistakes\": 1,\n    \"inaccuracies\": 3\n  },\n  \"black\": {\n    \"accuracy\": 78.5,\n    \"blunders\": 2,\n    \"mistakes\": 2,\n    \"inaccuracies\": 4\n  }\n}\n

404 Not Found — Match not found.

Get Latest Matches

Returns the most recently added chess matches, sorted by creation date in descending order.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/latest\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`limit`	number	Number of recent matches to return (optional)

Response

200 OK — A list of the most recently added matches.

Returns the most viewed or popular chess matches — based on engagement metrics like views or saves.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/trending\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`limit`	number	Number of trending matches to return (optional)

Response

200 OK — A list of trending matches.

Get a Random Match

Returns a randomly selected chess match from the database. Great for exploring games or testing.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/random\nAuth Required: No

Response

200 OK — Returns a single random match object.

Archive a Match

Archives a match — hides it from regular listings without permanently deleting it. Archived matches can be restored later.

Method: PATCH\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/archive\nAuth Required: Yes (Bearer Token)

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The ID of the match to archive

Response

200 OK — Match archived successfully.

404 Not Found — Match not found.

\n
💡 Use this instead of Delete when you want to keep the data but hide it from public listings.
\n

\n","urlObject":{"path":["api","v1","matches",":matchId","archive"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[{"type":"any","value":"Y1oXTO75","key":"matchId"}]}},"response":[],"_postman_id":"1e5d4262-e0a9-4440-b0a9-17144b24e915"},{"name":"Restore Match","id":"6e5d447c-211e-4c1a-b9bb-ddbd91f6abce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/restore","description":"

Restore a Match

Restores a previously archived match back to active status so it appears in regular listings again.

Method: PATCH\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId/restore\nAuth Required: Yes (Bearer Token)

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`matchId`	The ID of the archived match to restore

Response

200 OK — Match restored successfully.

404 Not Found — Match not found or not currently archived.

\n","urlObject":{"path":["api","v1","matches",":matchId","restore"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[{"type":"any","value":"Y1oXTO75","key":"matchId"}]}},"response":[],"_postman_id":"6e5d447c-211e-4c1a-b9bb-ddbd91f6abce"},{"name":"Filter Draws","id":"d1af85e1-b432-4506-be6e-37301f169e66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/draws","description":"

Filter Drawn Games

Returns only matches that ended in a draw (e.g., stalemate, repetition, insufficient material, or agreement).

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/draws\nAuth Required: No

Response

200 OK — A list of drawn matches.

Filter Resignation Games

Returns only matches that ended by resignation — where one player gave up before checkmate.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/resignations\nAuth Required: No

Response

200 OK — A list of matches that ended by resignation.

Filter Timeout Games

Returns only matches that ended due to a timeout — where one player ran out of time.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/timeouts\nAuth Required: No

Response

200 OK — A list of matches that ended by timeout.

Filter Rapid Games

Returns only matches played with a rapid time control — typically 10 to 25 minutes per player.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/rapid\nAuth Required: No

Response

200 OK — A list of rapid matches.

Filter Blitz Games

Returns only matches played with a blitz time control — typically 3 to 5 minutes per player.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/blitz\nAuth Required: No

Response

200 OK — A list of blitz matches.

Filter Bullet Games

Returns only matches played with a bullet time control — typically 1 to 2 minutes per player. These are the fastest chess games.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/bullet\nAuth Required: No

Response

200 OK — A list of bullet matches.

Filter Classical Games

Returns only matches played with a classical time control — typically 30+ minutes per player. These are the most traditional and in-depth chess games.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/classical\nAuth Required: No

Response

200 OK — A list of classical time control matches.

Filter High Rated Games

Returns matches where both players have a high Elo rating (e.g., above 2000). Great for studying master-level games.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/high-rated\nAuth Required: No

Response

200 OK — A list of matches between high-rated players.

Filter Low Rated Games

Returns matches where both players have a low Elo rating (e.g., below 1200). Useful for studying beginner-level games.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/low-rated\nAuth Required: No

Response

200 OK — A list of matches between low-rated players.

Filter Long Games

Returns matches that had a high number of moves — typically games that lasted a long time before a result.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/filter/long-games\nAuth Required: No

Response

200 OK — A list of long matches (many moves).

Bulk Upload Matches

Uploads and saves multiple chess matches at once in a single request. Ideal for importing large datasets.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk-upload\nAuth Required: Yes (Bearer Token)

Request Body (JSON)

{\n  \"matches\": [\n    {\n      \"white\": \"magnus\",\n      \"black\": \"hikaru\",\n      \"winner\": \"white\",\n      \"moves\": 42,\n      \"rated\": true,\n      \"timeControl\": \"blitz\"\n    },\n    {\n      \"white\": \"fabiano\",\n      \"black\": \"anish\",\n      \"winner\": \"draw\",\n      \"moves\": 60,\n      \"rated\": true,\n      \"timeControl\": \"classical\"\n    }\n  ]\n}\n

Response

201 Created — All matches uploaded successfully.

400 Bad Request — One or more matches have invalid or missing fields.

\n","urlObject":{"path":["api","v1","matches","bulk-upload"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6fb6738-133c-4290-8d1f-572f3aad0ef5"},{"name":"Bulk Update","id":"ed4c3a35-23df-4c39-b349-f1049ee2083e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk-update","description":"

Bulk Update Matches

Updates multiple matches at once by providing an array of match IDs and the fields to update.

Method: PATCH\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk-update\nAuth Required: ✅ Yes (Bearer Token)

Request Body (JSON)

{\n  \"ids\": [\"matchId1\", \"matchId2\"],\n  \"updates\": {\n    \"rated\": true,\n    \"timeControl\": \"blitz\"\n  }\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`ids`	array	✅ Yes	Array of match IDs to update
`updates`	object	✅ Yes	Key-value pairs of fields to update

Response

200 OK — All specified matches updated successfully.

400 Bad Request — Invalid IDs or update fields.

\n","urlObject":{"path":["api","v1","matches","bulk-update"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed4c3a35-23df-4c39-b349-f1049ee2083e"},{"name":"Bulk Delete","id":"7ed87e16-3e66-43d3-91fb-8ffafcbc7baa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk-delete","description":"

Bulk Delete Matches

Permanently deletes multiple matches at once by providing an array of match IDs.

Method: DELETE\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk-delete\nAuth Required: Yes (Bearer Token)

Request Body (JSON)

{\n  \"matchIds\": [\"abc001\", \"abc002\", \"abc003\"]\n}\n

Response

200 OK — All specified matches deleted.

400 Bad Request — Invalid or missing match IDs.

\n
⚠️ This permanently removes all specified matches. This action cannot be undone.
\n

\n","urlObject":{"path":["api","v1","matches","bulk-delete"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ed87e16-3e66-43d3-91fb-8ffafcbc7baa"},{"name":"Bulk Archive","id":"3fc61ae9-ad06-4dea-b2f9-f18c96075c68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk/archive","description":"

Bulk Archive Matches

Archives multiple matches at once by providing an array of match IDs. Much faster than archiving one by one.

Method: PATCH\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk/archive\nAuth Required: Yes (Bearer Token)

Request Body (JSON)

{\n  \"matchIds\": [\"abc001\", \"abc002\", \"abc003\"]\n}\n

Response

200 OK — All specified matches archived successfully.

400 Bad Request — Invalid or missing match IDs.

\n","urlObject":{"path":["api","v1","matches","bulk","archive"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fc61ae9-ad06-4dea-b2f9-f18c96075c68"},{"name":"Bulk Restore","id":"7dfe7126-1e86-4e4b-a219-8c0f388138be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk/restore","description":"

Bulk Restore Matches

Restores multiple archived matches at once back to active status.

Method: PATCH\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/bulk/restore\nAuth Required: Yes (Bearer Token)

Request Body (JSON)

{\n  \"matchIds\": [\"abc001\", \"abc002\", \"abc003\"]\n}\n

Response

200 OK — All specified matches restored to active status.

400 Bad Request — Invalid or missing match IDs.

\n","urlObject":{"path":["api","v1","matches","bulk","restore"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7dfe7126-1e86-4e4b-a219-8c0f388138be"},{"name":"Scroll Pagination","id":"93c3a6fd-2a6d-4501-a0bf-a9bacc18912a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/scroll","description":"

Cursor-Based Scroll Pagination

Fetches matches using cursor-based pagination — instead of page numbers, a cursor points to a specific position in the dataset. More efficient for large datasets.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/scroll\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`limit`	number	Number of results to return
`cursor`	string	Cursor value from the previous response

Response

200 OK — Returns matches and a nextCursor for the next batch.

Infinite Scroll Pagination

Fetches matches using an infinite scroll pattern — loads a batch of results and provides a cursor or token to load the next batch. Ideal for mobile apps or continuous-scroll UIs.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/infinite\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`limit`	number	Number of matches to return per batch
`after`	string	Cursor from the previous response to get the next batch

Response

200 OK — Returns a batch of matches and a nextCursor for the next page.

Sort Matches — Shortest First

Returns all matches sorted by number of moves in ascending order — shortest games appear first.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/shortest\nAuth Required: No

Response

200 OK — A list of matches sorted from fewest to most moves.

Sort Matches — Longest First

Returns all matches sorted by number of moves in descending order — longest games appear first.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/longest\nAuth Required: No

Response

200 OK — A list of matches sorted from most to fewest moves.

Sort Matches — Highest Rated First

Returns all matches sorted by average player rating in descending order — highest-rated games appear first.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/highest-rated\nAuth Required: No

Response

200 OK — A list of matches sorted from highest to lowest average rating.

Search Matches

Performs a general keyword search across all matches. You can search by player name, opening, result, or any other match field.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/matches?q=white\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`q`	string	✅ Yes	The search keyword or phrase

Response

200 OK — Returns a list of matches matching the search query.

400 Bad Request — Missing q parameter.

Search Players

Searches for players by name or username. Returns a list of players matching the query.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/players?q=carlsen\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`q`	string	✅ Yes	Player name or username to search for

Response

200 OK — Returns a list of matching player profiles.

400 Bad Request — Missing q parameter.

Search Openings

Searches for chess openings by name. Returns openings that match the search query.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/openings?q=sicilian\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`q`	string	✅ Yes	Opening name to search for (e.g., `sicilian`, `ruy lopez`)

Response

200 OK — Returns a list of matching openings with their ECO codes and statistics.

Search by ECO Code

Searches for matches or openings using a specific ECO (Encyclopaedia of Chess Openings) code. ECO codes are a standardized classification system for chess openings (e.g., A00–E99).

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/eco?q=B20\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`q`	string	✅ Yes	ECO code to search for (e.g., `B20`, `E60`)

Response

200 OK — Returns matches or openings associated with the given ECO code.

Search by Move Sequence

Searches for matches that contain a specific sequence of moves. Useful for finding games that followed a particular line or variation.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/moves\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`moves`	string	✅ Yes	Move sequence in algebraic notation (e.g., `e4 c5 Nf3`)

Response

200 OK — Returns a list of matches containing the specified move sequence.

Fuzzy Search

Performs a fuzzy (approximate) search — finds results even if the query has slight spelling variations or typos. Great for searching player names or opening names when you're not sure of the exact spelling.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/fuzzy\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`q`	string	✅ Yes	The approximate search term

Response

200 OK — Returns results that closely match the query, even with minor spelling differences.

Search Autocomplete

Returns autocomplete suggestions as the user types — useful for building search bars that suggest player names, openings, or match titles in real time.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/autocomplete\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`q`	string	✅ Yes	Partial text to get suggestions for

Response

200 OK — Returns an array of suggested completions.

{\n  \"suggestions\": [\"Sicilian Defense\", \"Sicilian Dragon\", \"Sicilian Najdorf\"]\n}\n

Get Recent Searches

Returns the most recent search queries made by users. Useful for showing a search history or trending search terms.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/recent\nAuth Required: No

Response

200 OK — Returns a list of recent search terms.

Get Popular Searches

Returns the most frequently searched terms across all users. Useful for discovering what players are most interested in.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/popular\nAuth Required: No

Response

200 OK — Returns a list of popular search terms with their frequency counts.

Advanced Search

Performs a multi-field search with multiple filters applied simultaneously. Combine player names, openings, results, ratings, time controls, and date ranges in a single query.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/advanced\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`white`	string	White player's username
`black`	string	Black player's username
`result`	string	Match result: `1-0`, `0-1`, `1/2-1/2`
`opening`	string	Opening name
`eco`	string	ECO code
`timeControl`	string	Time control type
`minRating`	number	Minimum average player rating
`maxRating`	number	Maximum average player rating
`from`	string	Start date (ISO format)
`to`	string	End date (ISO format)

Response

200 OK — Returns matches matching all provided filters.

Search by Player Rating

Searches for matches within a specific Elo rating range. Useful for finding games between players of a particular skill level.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/player-rating\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`min`	number	No	Minimum Elo rating
`max`	number	No	Maximum Elo rating

Response

200 OK — Returns matches where player ratings fall within the specified range.

Search by Date Range

Returns matches played within a specific date range. Useful for finding games from a particular time period.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/date-range\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`from`	string	✅ Yes	Start date in ISO format (e.g., `2024-01-01`)
`to`	string	✅ Yes	End date in ISO format (e.g., `2024-12-31`)

Response

200 OK — Returns matches played between the specified dates.

Search by Opening Family

Searches for matches grouped by opening family — a broad category of related openings (e.g., all Sicilian variations, all King's Pawn openings).

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/opening-family\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`family`	string	✅ Yes	Opening family name (e.g., `sicilian`, `kings-pawn`)

Response

200 OK — Returns matches belonging to the specified opening family.

Search Checkmate Patterns

Searches for matches that ended with a specific checkmate pattern (e.g., back-rank mate, smothered mate, scholar's mate).

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/checkmate-patterns\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`pattern`	string	No	Checkmate pattern name to search for

Response

200 OK — Returns matches that ended with the specified checkmate pattern.

Search Endgames

Searches for matches that reached a specific endgame type (e.g., rook endgame, pawn endgame, king and pawn vs king).

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/endgames\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`type`	string	No	Endgame type to search for (e.g., `rook`, `pawn`, `queen`)

Response

200 OK — Returns matches that reached the specified endgame type.

Victory Distribution

Returns a breakdown of how matches end — showing the percentage or count of white wins, black wins, and draws across all games.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/victory-distribution\nAuth Required: No

Response

200 OK — Returns victory distribution data.

{\n  \"whiteWins\": 45,\n  \"blackWins\": 35,\n  \"draws\": 20\n}\n

Color Advantage Analysis

Analyzes the statistical advantage of playing White vs Black — showing win rates for each color across all matches in the database.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/color-advantage\nAuth Required: No

Response

200 OK — Returns win rate percentages for White and Black.

{\n  \"whiteWinRate\": 52.3,\n  \"blackWinRate\": 44.1,\n  \"drawRate\": 3.6\n}\n

Average Turn Count

Returns the average number of moves per game across all matches. Useful for understanding typical game length.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/turn-count-average\nAuth Required: No

Response

200 OK — Returns the average move count.

{\n  \"averageMoves\": 38.7\n}\n

Rated vs Casual Games Analysis

Returns a comparison of rated vs unrated (casual) games — showing how many games of each type are in the database.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/rated-vs-casual\nAuth Required: No

Response

200 OK — Returns counts and percentages for rated and casual games.

{\n  \"rated\": 320,\n  \"casual\": 180,\n  \"ratedPercentage\": 64\n}\n

Opening Success Rates

Returns win rate statistics for each opening — showing which openings lead to the most wins for White, Black, or draws.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/opening-success\nAuth Required: No

Response

200 OK — Returns a list of openings with their win/draw/loss rates.

[\n  {\n    \"opening\": \"Sicilian Defense\",\n    \"whiteWinRate\": 48,\n    \"blackWinRate\": 38,\n    \"drawRate\": 14\n  }\n]\n

Shortest Games Analysis

Returns data about the shortest games in the database — including the minimum move count and a list of the quickest matches.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/shortest-games\nAuth Required: No

Response

200 OK — Returns the shortest games with their move counts and details.

Longest Games Analysis

Returns data about the longest games in the database — including the maximum move count and a list of the most extended matches.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/longest-games\nAuth Required: No

Response

200 OK — Returns the longest games with their move counts and details.

Rating Gap Upsets

Returns matches where a lower-rated player defeated a higher-rated player — the bigger the rating gap, the bigger the upset. Great for finding surprising results.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/rating-gap-upsets\nAuth Required: No

Response

200 OK — Returns a list of upset matches sorted by rating gap (largest first).

[\n  {\n    \"matchId\": \"abc123\",\n    \"winner\": \"underdog\",\n    \"loser\": \"favorite\",\n    \"ratingGap\": 400\n  }\n]\n

Checkmate Frequency

Returns statistics on how often games end in checkmate versus other outcomes (resignation, timeout, draw). Useful for understanding game termination patterns.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/checkmate-frequency\nAuth Required: No

Response

200 OK — Returns checkmate frequency data.

{\n  \"checkmates\": 120,\n  \"total\": 500,\n  \"percentage\": 24\n}\n

Draw Frequency

Returns statistics on how often games end in a draw — including stalemate, repetition, insufficient material, and mutual agreement.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/draw-frequency\nAuth Required: No

Response

200 OK — Returns draw frequency data.

{\n  \"draws\": 85,\n  \"total\": 500,\n  \"percentage\": 17\n}\n

Resignation Frequency

Returns statistics on how often games end by resignation — where a player gives up before checkmate.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/resignation-frequency\nAuth Required: No

Response

200 OK — Returns resignation frequency data.

{\n  \"resignations\": 210,\n  \"total\": 500,\n  \"percentage\": 42\n}\n

Timeout Frequency

Returns statistics on how often games end due to a timeout — where a player runs out of time on the clock.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/timeouts\nAuth Required: No

Response

200 OK — Returns timeout frequency data.

{\n  \"timeouts\": 65,\n  \"total\": 500,\n  \"percentage\": 13\n}\n

Player Growth Analytics

Returns data on how the number of players has grown over time — showing new player registrations by day, week, or month.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/player-growth\nAuth Required: No

Response

200 OK — Returns player growth data over time.

[\n  { \"period\": \"2024-01\", \"newPlayers\": 45 },\n  { \"period\": \"2024-02\", \"newPlayers\": 62 }\n]\n

Hourly Activity

Returns a breakdown of when games are most frequently played — showing match counts grouped by hour of the day (0–23). Useful for understanding peak usage times.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/hourly-activity\nAuth Required: No

Response

200 OK — Returns match counts per hour.

[\n  { \"hour\": 14, \"matches\": 87 },\n  { \"hour\": 20, \"matches\": 134 }\n]\n

Time Control Usage

Returns a breakdown of which time controls are most commonly used — showing the distribution of bullet, blitz, rapid, and classical games.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/time-control-usage\nAuth Required: No

Response

200 OK — Returns time control distribution data.

{\n  \"bullet\": 120,\n  \"blitz\": 250,\n  \"rapid\": 100,\n  \"classical\": 30\n}\n

Total Matches

Returns the total number of chess matches stored in the database.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/stats/total-matches\nAuth Required: No

Response

200 OK — Returns the total match count.

{\n  \"totalMatches\": 1500\n}\n

Total Players

Returns the total number of unique players in the database.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/stats/total-players\nAuth Required: No

Response

200 OK — Returns the total player count.

{\n  \"totalPlayers\": 342\n}\n

Average Player Rating

Returns the average Elo rating across all players in the database.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/stats/average-rating\nAuth Required: No

Response

200 OK — Returns the average rating.

{\n  \"averageRating\": 1487\n}\n

Health Check

Checks whether the API server is running and healthy. This is the simplest endpoint to verify that the server is up and responding.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/health\nAuth Required: No

Response

200 OK — Server is healthy and running.

{\n  \"status\": \"ok\",\n  \"message\": \"Server is healthy\"\n}\n

\n
💡 Use this endpoint to monitor server availability or as a ping check in uptime monitoring tools.
\n

System Status

Returns the overall status of the system — including whether all services (database, cache, etc.) are operational.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/status\nAuth Required: No

Response

200 OK — Returns system status summary.

{\n  \"status\": \"operational\",\n  \"services\": {\n    \"database\": \"up\",\n    \"cache\": \"up\"\n  }\n}\n

System Version

Returns the current version of the API — useful for checking which release is deployed.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/version\nAuth Required: No

Response

200 OK — Returns the API version string.

{\n  \"version\": \"1.0.0\",\n  \"releaseDate\": \"2024-01-15\"\n}\n

System Uptime

Returns how long the server has been running since its last restart — expressed in seconds, minutes, or a human-readable format.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/uptime\nAuth Required: No

Response

200 OK — Returns the server uptime.

{\n  \"uptime\": 86400,\n  \"uptimeFormatted\": \"1 day, 0 hours\"\n}\n

Database Status

Returns the current status of the database connection — whether it's connected, the number of active connections, and any relevant metrics.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/database/status\nAuth Required: No

Response

200 OK — Returns database connection status.

{\n  \"connected\": true,\n  \"activeConnections\": 5,\n  \"latency\": \"2ms\"\n}\n

System Info

Returns detailed information about the server environment — including Node.js version, platform, memory usage, and CPU details.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/info\nAuth Required: No

Response

200 OK — Returns system environment details.

{\n  \"nodeVersion\": \"v18.12.0\",\n  \"platform\": \"linux\",\n  \"memory\": {\n    \"total\": \"8GB\",\n    \"used\": \"2.1GB\"\n  },\n  \"cpus\": 4\n}\n

System Logs

Returns the most recent server logs — useful for debugging errors, monitoring activity, and auditing system events.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/logs\nAuth Required: No

Response

200 OK — Returns an array of recent log entries.

[\n  {\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"level\": \"info\",\n    \"message\": \"Server started on port 3000\"\n  },\n  {\n    \"timestamp\": \"2024-01-15T10:31:00Z\",\n    \"level\": \"error\",\n    \"message\": \"Database connection timeout\"\n  }\n]\n

Cache Status

Returns the current status of the cache layer — including whether it's active, hit/miss rates, and memory usage.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/cache/status\nAuth Required: No

Response

200 OK — Returns cache status details.

{\n  \"enabled\": true,\n  \"hitRate\": \"87%\",\n  \"memoryUsed\": \"512MB\"\n}\n

Recalculate Stats

Triggers a manual recalculation of all statistics in the database — such as win rates, average ratings, and match counts. Use this after bulk data imports or corrections.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/recalculate-stats\nAuth Required: Yes (Admin)

Response

200 OK — Stats recalculation triggered successfully.

{\n  \"message\": \"Stats recalculation started\",\n  \"status\": \"processing\"\n}\n

\n
⚠️ This is an admin-level operation. Ensure you have the appropriate permissions before calling this endpoint.
\n

Reindex Database

Triggers a manual reindexing of the database — rebuilding search indexes to improve query performance. Useful after large data imports or schema changes.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/reindex\nAuth Required: Yes (Admin)

Response

200 OK — Reindexing started successfully.

{\n  \"message\": \"Database reindexing started\",\n  \"status\": \"processing\"\n}\n

\n
⚠️ This operation may temporarily slow down the database. Run it during off-peak hours.
\n

Restart System

Triggers a graceful restart of the API server. All active connections are closed cleanly before the server restarts.

Method: POST\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/restart\nAuth Required: Yes (Admin)

Response

200 OK — Restart initiated.

{\n  \"message\": \"System restart initiated\",\n  \"estimatedDowntime\": \"5 seconds\"\n}\n

\n
⚠️ Use with caution. This will temporarily make the API unavailable. Only use in emergencies or during scheduled maintenance.
\n

System Config

Returns the current server configuration — including environment settings, feature flags, and runtime parameters.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/config\nAuth Required: No

Response

200 OK — Returns the active configuration.

{\n  \"environment\": \"production\",\n  \"maxPageSize\": 100,\n  \"cacheEnabled\": true,\n  \"rateLimitPerMinute\": 60\n}\n

Security Events

Returns a log of recent security-related events — such as failed login attempts, unauthorized access, and suspicious activity.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/security/events\nAuth Required: Yes (Admin)

Response

200 OK — Returns a list of security events.

[\n  {\n    \"timestamp\": \"2024-01-15T09:00:00Z\",\n    \"event\": \"failed_login\",\n    \"ip\": \"192.168.1.1\",\n    \"username\": \"unknown\"\n  }\n]\n

Performance Metrics

Returns real-time performance metrics for the API server — including response times, request throughput, memory usage, and CPU load.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/performance\nAuth Required: No

Response

200 OK — Returns performance data.

{\n  \"avgResponseTime\": \"45ms\",\n  \"requestsPerMinute\": 120,\n  \"memoryUsage\": \"1.8GB\",\n  \"cpuLoad\": \"12%\"\n}\n

Storage Analytics

Returns storage usage statistics for the system — including total disk space, used space, and a breakdown by data type (matches, logs, etc.).

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/storage\nAuth Required: No

Response

200 OK — Returns storage usage data.

{\n  \"totalStorage\": \"100GB\",\n  \"usedStorage\": \"34GB\",\n  \"breakdown\": {\n    \"matches\": \"20GB\",\n    \"logs\": \"5GB\",\n    \"other\": \"9GB\"\n  }\n}\n

Get All Players

Returns a paginated list of all players in the database, including their usernames and basic profile information.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players\nAuth Required: No

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`page`	number	Page number (default: 1)
`limit`	number	Results per page (default: 10)

Response

200 OK — Returns a list of players.

{\n  \"players\": [\n    { \"username\": \"magnus\", \"rating\": 2850 },\n    { \"username\": \"hikaru\", \"rating\": 2780 }\n  ],\n  \"total\": 342,\n  \"page\": 1\n}\n

Get Player Details

Returns detailed profile information for a specific player by their username.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`username`	The player's username (e.g., `magnus`)

Response

200 OK — Returns the player's full profile.

{\n  \"username\": \"magnus\",\n  \"rating\": 2850,\n  \"country\": \"Norway\",\n  \"totalGames\": 1200,\n  \"wins\": 800,\n  \"losses\": 200,\n  \"draws\": 200\n}\n

404 Not Found — Player does not exist.

Get Player History

Returns the full match history for a specific player — a list of all games they have played, with results and opponents.

Method: GET\nURL: https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/history\nAuth Required: No

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`username`	The player's username (e.g., `magnus`)

Response

200 OK — Returns a list of past matches for the player.

[\n  {\n    \"matchId\": \"abc123\",\n    \"opponent\": \"hikaru\",\n    \"result\": \"win\",\n    \"date\": \"2024-01-10\"\n  }\n]\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","history"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ac0542a-e3ad-4230-a115-14a76922a0f5"},{"name":"Get Player Stats","id":"1b445d42-2d4a-4b73-9391-94bb76d503c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/stats","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","stats"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b445d42-2d4a-4b73-9391-94bb76d503c0"},{"name":"Get Player Openings","id":"3d187ba6-3c9f-4432-a2b6-1fd3c9d9d276","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/openings","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","openings"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d187ba6-3c9f-4432-a2b6-1fd3c9d9d276"},{"name":"Get Player Rating History","id":"50234731-8b82-40d5-aada-c7c9ebc47a51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/rating-history","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","rating-history"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"50234731-8b82-40d5-aada-c7c9ebc47a51"},{"name":"Get Player Win Rate","id":"88b52aca-62c8-486e-9ba0-a543118a6815","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/win-rate","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","win-rate"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"88b52aca-62c8-486e-9ba0-a543118a6815"},{"name":"Get Player Loss Rate","id":"c603f7a5-41d6-480d-817a-aacaf21eb1e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/loss-rate","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","loss-rate"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c603f7a5-41d6-480d-817a-aacaf21eb1e2"},{"name":"Get Player Draw Rate","id":"4aaa7348-6657-4063-bf7c-6ee36290421c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/draw-rate","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","draw-rate"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4aaa7348-6657-4063-bf7c-6ee36290421c"},{"name":"Get Recent Matches","id":"1116e29d-3525-4381-a30d-328ac745ff9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/magnus/recent","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","magnus","recent"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1116e29d-3525-4381-a30d-328ac745ff9c"},{"name":"Get Top Rated Players","id":"91240b31-f450-4ec6-9f75-19643a4b19dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/top-rated","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","top-rated"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"91240b31-f450-4ec6-9f75-19643a4b19dd"},{"name":"Get Top Active Players","id":"e50da67a-4b33-40c7-9a8e-8e1aae9531ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/top-active","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","top-active"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e50da67a-4b33-40c7-9a8e-8e1aae9531ac"},{"name":"Get Top Winning Players","id":"4b7d9ddb-3876-472b-8b4e-913916e22e47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/top-winning","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","top-winning"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b7d9ddb-3876-472b-8b4e-913916e22e47"},{"name":"Compare Players","id":"faff7c48-41cf-44da-a464-6347a4f48c12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/compare/player1/player2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","compare","player1","player2"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"faff7c48-41cf-44da-a464-6347a4f48c12"},{"name":"Filter by Rating","id":"c5e43d22-4596-48a9-9618-f37afb6f4111","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/rating-range","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players","rating-range"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5e43d22-4596-48a9-9618-f37afb6f4111"}],"id":"c565afae-dd73-470a-a45c-98eb9ba94c9c","_postman_id":"c565afae-dd73-470a-a45c-98eb9ba94c9c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"Openings Theory","item":[{"name":"Get All Openings","id":"78e48bd3-1d4a-4297-b891-f5d509411026","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"78e48bd3-1d4a-4297-b891-f5d509411026"},{"name":"Popular Openings","id":"99e66ff0-cf0e-4e80-a9b4-bd1fe16e9aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/popular","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","popular"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"99e66ff0-cf0e-4e80-a9b4-bd1fe16e9aa9"},{"name":"Trending Openings","id":"a3156da3-1904-4305-bdbd-52b4016ed618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/trending","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","trending"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3156da3-1904-4305-bdbd-52b4016ed618"},{"name":"Search Openings","id":"5c16b055-3e0d-481d-8e51-eec63da84523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/search","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","search"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c16b055-3e0d-481d-8e51-eec63da84523"},{"name":"Opening Win Rates","id":"96bcc922-c055-460b-bff7-7049b017359e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/win-rates","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","win-rates"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"96bcc922-c055-460b-bff7-7049b017359e"},{"name":"Aggressive Openings","id":"bc57d500-3033-4ef9-b81c-8e5439e19b21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/aggressive","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","aggressive"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc57d500-3033-4ef9-b81c-8e5439e19b21"},{"name":"Defensive Openings","id":"838c7498-af84-4b4a-be0c-8ad2cc75ecaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/defensive","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","defensive"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"838c7498-af84-4b4a-be0c-8ad2cc75ecaa"},{"name":"Gambits","id":"3f76298f-e469-4a99-af88-87ba8faff98e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/gambits","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","gambits"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f76298f-e469-4a99-af88-87ba8faff98e"},{"name":"Checkmates","id":"bd7d1fcd-7fdb-4f6c-8ed8-13d2abfb1562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/checkmates","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","checkmates"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd7d1fcd-7fdb-4f6c-8ed8-13d2abfb1562"},{"name":"Rare Openings","id":"1dfb8f31-efd4-4b84-9f49-bebdce3dbfe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/rare","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","rare"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1dfb8f31-efd4-4b84-9f49-bebdce3dbfe1"},{"name":"White Advantage","id":"4ee6319d-2846-46fd-b2cf-77442f6beec5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/white-advantage","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","white-advantage"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ee6319d-2846-46fd-b2cf-77442f6beec5"},{"name":"Black Advantage","id":"b564a1c8-6abb-4551-afed-966e26d5ad88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/black-advantage","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","black-advantage"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b564a1c8-6abb-4551-afed-966e26d5ad88"},{"name":"Beginner Friendly","id":"91db6a9c-77e0-4210-b059-702b837fd48e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/beginner-friendly","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","beginner-friendly"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"91db6a9c-77e0-4210-b059-702b837fd48e"},{"name":"Complexity","id":"874e890c-2ee5-41eb-b6fd-14b7b3a18aba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/complexity","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","complexity"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"874e890c-2ee5-41eb-b6fd-14b7b3a18aba"},{"name":"By ECO Code","id":"a18c1401-1432-4b77-86a8-111f73e93527","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings/eco/B20","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings","eco","B20"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a18c1401-1432-4b77-86a8-111f73e93527"}],"id":"7e6dacbd-91b0-4943-9b3d-f89260f521cf","description":"

Openings Theory

This folder contains endpoints for exploring and analyzing chess openings — the initial moves of a chess game that establish the foundation for middlegame strategy. Chess opening theory is a vast, well-documented field where each sequence of moves has been studied, named, and classified based on strategic goals, pawn structures, and tactical patterns.

Openings are broadly categorized by the ECO (Encyclopaedia of Chess Openings) code system, which organizes all known openings into five volumes (A through E), each subdivided into 100 codes (e.g., A00–A99). This API supports ECO-based lookups alongside a rich set of filters for style, complexity, and statistical performance.

Endpoints Overview

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Description
`GET /api/v1/openings`	Retrieve the full list of all known openings in the database
`GET /api/v1/openings/popular`	Fetch the most frequently played openings across all skill levels
`GET /api/v1/openings/trending`	Get openings that are currently gaining popularity in recent games
`GET /api/v1/openings/search`	Search openings by name, ECO code, or move sequence
`GET /api/v1/openings/win-rates`	Retrieve win rate statistics (White wins, Black wins, draws) per opening
`GET /api/v1/openings/aggressive`	List openings known for sharp, attacking, and tactical play
`GET /api/v1/openings/defensive`	List openings focused on solid, positional, and defensive setups
`GET /api/v1/openings/gambits`	Retrieve openings that involve material sacrifices (gambits) for initiative
`GET /api/v1/openings/checkmates`	Openings associated with common checkmate patterns or mating attacks
`GET /api/v1/openings/rare`	Discover uncommon or unorthodox openings rarely seen in competitive play
`GET /api/v1/openings/white-advantage`	Openings that statistically favor White
`GET /api/v1/openings/black-advantage`	Openings that statistically favor Black
`GET /api/v1/openings/beginner-friendly`	Openings recommended for beginners due to simplicity and clear plans
`GET /api/v1/openings/complexity`	Retrieve openings ranked or filtered by theoretical complexity
`GET /api/v1/openings/eco/:code`	Look up a specific opening by its ECO code (e.g., `B20` for the Sicilian Defense)

ECO Code System

The ECO (Encyclopaedia of Chess Openings) classification is the standard reference system for chess openings:

Volume A (A00–A99) — Flank openings, Dutch Defense, English Opening, and other irregular openings
Volume B (B00–B99) — Semi-Open Games (e.g., Sicilian Defense B20–B99, Caro-Kann B10–B19)
Volume C (C00–C99) — Open Games and French Defense (e.g., Ruy López C60–C99, Italian Game C50–C59)
Volume D (D00–D99) — Closed Games and Semi-Closed Games (e.g., Queen's Gambit D06–D69)
Volume E (E00–E99) — Indian Defenses (e.g., King's Indian E60–E99, Nimzo-Indian E20–E59)

Use the GET /api/v1/openings/eco/:code endpoint to query a specific ECO code directly (e.g., /eco/B20 for the Sicilian Defense).

Opening Categories

Openings in this API are tagged across several strategic dimensions:

Aggressive / Tactical — Openings like the King's Gambit or Sicilian Dragon that lead to sharp, double-edged positions
Defensive / Positional — Openings like the Berlin Defense or Caro-Kann that prioritize solidity and long-term structure
Gambits — Openings where a player sacrifices material (usually a pawn) for rapid development or attacking chances (e.g., Queen's Gambit, Evans Gambit)
Beginner-Friendly — Openings with straightforward plans and minimal theoretical depth, ideal for learning (e.g., London System, Italian Game)
Rare / Unorthodox — Offbeat openings that deviate from mainstream theory, often used as surprise weapons

Notes

All endpoints use https://chess-game-dataset-harshit-kumar.onrender.com as the base URL variable. Ensure this is set in your active environment (e.g., http://localhost:3000 or your deployed API URL).
Win rate data from /win-rates reflects aggregate statistics across all matches stored in the database and may vary based on dataset size.
The /trending endpoint reflects recent activity and may return different results over time as new match data is ingested.
ECO codes are case-insensitive in most implementations, but it is recommended to use uppercase (e.g., B20, C65) for consistency.

\n","_postman_id":"7e6dacbd-91b0-4943-9b3d-f89260f521cf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"Admin & Middleware","item":[{"name":"Get All Users","id":"5d24f412-3320-4b41-8583-afa8d93943cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","users"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d24f412-3320-4b41-8583-afa8d93943cb"},{"name":"Get System Logs","id":"c0cb748d-48c7-4806-80d6-ca3cff2fc157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/logs","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","logs"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0cb748d-48c7-4806-80d6-ca3cff2fc157"},{"name":"Admin System Health","id":"057d7d5f-39d8-486c-b580-f82f79998b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/system/health","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","system","health"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"057d7d5f-39d8-486c-b580-f82f79998b2e"},{"name":"Clear Cache","id":"55191a9e-30cf-4180-bfd8-1aadc433fb11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/cache/clear","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","cache","clear"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"55191a9e-30cf-4180-bfd8-1aadc433fb11"},{"name":"Ban User","id":"c3e44bcd-19b6-4e77-9f0d-e7072dc02971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users/123/ban","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","users","123","ban"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3e44bcd-19b6-4e77-9f0d-e7072dc02971"},{"name":"Unban User","id":"1e82faf1-d0da-46b0-a451-e9d1e8a33ba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users/123/unban","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","users","123","unban"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e82faf1-d0da-46b0-a451-e9d1e8a33ba0"},{"name":"Protected Dashboard","id":"327e5acd-4957-47eb-8cdc-772b58027d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/protected/dashboard","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","protected","dashboard"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"327e5acd-4957-47eb-8cdc-772b58027d21"},{"name":"Logger Middleware","id":"2dfbf79c-e077-446e-a63a-505caffc19c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/logger","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","middleware","logger"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2dfbf79c-e077-446e-a63a-505caffc19c9"},{"name":"Auth Middleware","id":"7a292f87-1a62-4dc3-9d6e-e4e30c1046d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/auth","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","middleware","auth"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a292f87-1a62-4dc3-9d6e-e4e30c1046d5"},{"name":"Rate Limit Middleware","id":"901c5352-015a-4593-8dfb-f8ebb0ce3ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/rate-limit","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","middleware","rate-limit"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"901c5352-015a-4593-8dfb-f8ebb0ce3ac6"},{"name":"Error Handler","id":"23b69d65-3700-4e3a-9af0-bb24eeabedbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/error-handler","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","middleware","error-handler"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"23b69d65-3700-4e3a-9af0-bb24eeabedbd"},{"name":"Protected Matches","id":"c1eeed24-87ef-4fcc-8091-22218e533aa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/protected/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","protected","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1eeed24-87ef-4fcc-8091-22218e533aa3"}],"id":"bc09bbf7-0ef0-4180-bcb3-58708c16c252","description":"

Admin & Middleware

Overview

This folder contains endpoints for admin-only operations and middleware testing within the Chess Match Analytics API. It is divided into two logical groups:

Admin Routes — Privileged endpoints for managing users, monitoring system health, viewing logs, and performing administrative actions such as banning/unbanning users and clearing cache.
Middleware Routes — Dedicated test endpoints that isolate and validate individual middleware layers including authentication, rate limiting, request logging, and error handling.

Authentication & Authorization

\n
⚠️ All admin routes require elevated privileges.
\n

Requests must include a valid Bearer token in the Authorization header:
```
Authorization: Bearer <admin_token>\n
```
The authenticated user must have an admin role. Requests from non-admin users will receive a 403 Forbidden response.
Middleware test routes may require a valid auth token depending on the middleware being tested (see individual request notes below).

Admin Endpoints

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

#	Request	Method	Endpoint
1	Get All Users	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users`
2	Get System Logs	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/logs`
3	Admin System Health	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/system/health`
4	Clear Cache	`DELETE`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/cache/clear`
5	Ban User	`PATCH`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users/123/ban`
6	Unban User	`PATCH`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users/123/unban`
7	Protected Dashboard	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/protected/dashboard`

Request Details

1. Get All Users\nRetrieves a paginated list of all registered users in the system. Useful for user management and auditing. Returns user metadata such as IDs, roles, and account status.

2. Get System Logs\nFetches server-side system logs for monitoring and debugging. Logs may include request traces, error events, and system-level activity. Supports filtering by log level or time range (if query params are available).

3. Admin System Health\nReturns the current health status of the system, including service uptime, database connectivity, memory usage, and other infrastructure metrics. Useful for operational monitoring.

4. Clear Cache\nPerforms a DELETE operation to flush the server-side cache. Use with caution — this may temporarily impact performance while the cache is rebuilt. Typically used after bulk data updates or deployments.

5. Ban User\nApplies a ban to the user with the specified ID (e.g., 123). Banned users are restricted from accessing protected resources. The user ID in the path should be replaced with the actual target user's ID.

6. Unban User\nReverses a previously applied ban for the specified user ID. Restores the user's access to the platform. The user ID in the path should be replaced with the actual target user's ID.

7. Protected Dashboard\nAccesses the admin-only dashboard view. This endpoint validates both authentication and admin-role authorization, making it a good end-to-end test for the full admin access control flow.

Middleware Endpoints

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

#	Request	Method	Endpoint
8	Logger Middleware	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/logger`
9	Auth Middleware	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/auth`
10	Rate Limit Middleware	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/rate-limit`
11	Error Handler	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/middleware/error-handler`
12	Protected Matches	`GET`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/protected/matches`

Middleware Details

8. Logger Middleware\nTests the request logging middleware. Verifies that incoming requests are properly logged with relevant metadata (method, path, timestamp, response time). Check server logs to confirm logging behavior.

9. Auth Middleware\nValidates the authentication middleware in isolation. Sending a request with and without a valid Authorization header allows you to confirm that the middleware correctly allows or rejects access based on token validity.

10. Rate Limit Middleware\nTests the rate limiting middleware. Sending repeated requests in quick succession should trigger a 429 Too Many Requests response once the threshold is exceeded. Use this to verify rate limit configuration and headers (e.g., X-RateLimit-Limit, X-RateLimit-Remaining).

11. Error Handler\nTriggers the global error handling middleware. This endpoint is designed to produce an error response, allowing you to verify that errors are caught, formatted consistently, and returned with appropriate HTTP status codes and messages.

12. Protected Matches\nA protected route that returns match data accessible only to authenticated users. Tests that the auth middleware correctly gates access to sensitive resources. Requires a valid Bearer token.

Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`https://chess-game-dataset-harshit-kumar.onrender.com`	The base URL of the API server (e.g., `http://localhost:3000`)

Ensure https://chess-game-dataset-harshit-kumar.onrender.com is set in your active Postman environment before running these requests.

\n","_postman_id":"bc09bbf7-0ef0-4180-bcb3-58708c16c252","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"Pagination","item":[{"name":"Standard pagination","id":"4569a658-ce68-4704-bf0b-96681cb07db8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4569a658-ce68-4704-bf0b-96681cb07db8"},{"name":"Fetch second page","id":"56dafecf-da47-4729-9f04-0b42592ac8ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56dafecf-da47-4729-9f04-0b42592ac8ce"},{"name":"Cursor based pagination","id":"a0a295f7-4696-4d01-a8d2-f6ad48e9c2f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/scroll","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","scroll"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0a295f7-4696-4d01-a8d2-f6ad48e9c2f9"},{"name":"Infinite scroll pagination","id":"c8f11a0d-1178-459c-8aad-f295c54c4b53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/infinite","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","infinite"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8f11a0d-1178-459c-8aad-f295c54c4b53"},{"name":"Paginated latest matches","id":"7040f4e4-1db9-4c8b-8e4e-6a8c86f912bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/latest","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","latest"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7040f4e4-1db9-4c8b-8e4e-6a8c86f912bb"},{"name":"Paginated trending matches","id":"06b3225b-715b-40f6-ab1c-bcbf947cf21e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/trending","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","trending"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"06b3225b-715b-40f6-ab1c-bcbf947cf21e"},{"name":"Paginated player history","id":"f1619cd9-fd88-4e75-8a1b-1e891c451fff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/:username/history","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players",":username","history"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[{"type":"any","key":"username"}]}},"response":[],"_postman_id":"f1619cd9-fd88-4e75-8a1b-1e891c451fff"},{"name":"Paginated openings","id":"571a0008-5e87-4020-8f9c-bb2419da56ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"571a0008-5e87-4020-8f9c-bb2419da56ea"},{"name":"Paginated search results","id":"2d6d751d-7902-46c9-8b76-1107258c9ef8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","search","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d6d751d-7902-46c9-8b76-1107258c9ef8"},{"name":"Paginated analytics results","id":"93aff8f2-23a0-423b-9544-29d3a81711e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/top-games","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","analytics","top-games"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"93aff8f2-23a0-423b-9544-29d3a81711e4"}],"id":"866b597f-4dd3-4ace-aca2-f18715e8cdee","description":"

Pagination

Pagination is a technique used to divide large datasets into smaller, manageable chunks (pages), allowing clients to retrieve data incrementally rather than fetching everything at once. It is essential for improving API performance, reducing server load, and delivering a better user experience — especially when dealing with large collections of chess matches, player histories, or analytics results.

Pagination Strategies

Offset-Based Pagination

The most common approach. Clients specify a page number and a limit (number of records per page). The server calculates the offset as (page - 1) * limit and returns the corresponding slice of data.

Pros: Simple to implement; supports random access to any page.
Cons: Can produce inconsistent results on frequently updated datasets (e.g., new records shifting pages).

Common query parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`page`	integer	The page number to retrieve (default: `1`)
`limit`	integer	Number of records per page (default: `10`)
`sort`	string	Field to sort by (e.g., `date`, `rating`)
`order`	string	Sort direction: `asc` or `desc`

Cursor-Based Pagination

Instead of page numbers, the server returns a cursor (an opaque token or encoded pointer) that the client passes in the next request to fetch the following page. Ideal for real-time or frequently updated feeds.

Pros: Consistent results even as data changes; efficient for large datasets.
Cons: No random access; clients must traverse pages sequentially.

Common query parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`cursor`	string	Opaque token returned by the previous response
`limit`	integer	Number of records to return per request
`after`	string	Fetch records after this cursor (forward pagination)
`before`	string	Fetch records before this cursor (backward pagination)

Requests in This Folder

1. Standard Pagination

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches

Retrieves the first page of chess matches using offset-based pagination. Use page and limit query parameters to control which page and how many results are returned.

2. Fetch Second Page

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches

Same endpoint as Standard Pagination, but with page=2 (or equivalent offset) to retrieve the second page of results. Demonstrates how to navigate through pages sequentially.

3. Cursor-Based Pagination

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/scroll

Retrieves matches using cursor-based pagination. Pass the cursor value returned from a previous response to fetch the next batch of results. Suitable for scenarios where data consistency across pages is critical.

4. Infinite Scroll Pagination

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/infinite

Designed for infinite scroll UI patterns. Returns a batch of matches along with a nextCursor token. Clients append results to the existing list and use the cursor to load more on demand.

5. Paginated Latest Matches

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/latest

Returns the most recently played matches in paginated form. Supports page and limit parameters to browse through the latest activity feed.

\n\n

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/trending

Returns trending or highly-viewed matches in paginated form. Useful for surfacing popular games to users in a browsable list.

7. Paginated Player History

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players/:username/history

Returns the match history for a specific player identified by :username. Supports pagination to browse through potentially large game histories. Replace :username with the actual player's username.

8. Paginated Openings

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings

Returns a paginated list of chess openings available in the system. Use page and limit to navigate through the full catalog of openings.

9. Paginated Search Results

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/matches

Returns paginated results for a match search query. Combine search/filter parameters with page and limit to browse through matching records efficiently.

10. Paginated Analytics Results

GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/analytics/top-games

Returns a paginated list of top-performing or analytically significant games. Useful for leaderboards, reports, and data exploration features.

Tips

Always check the response for totalPages, totalCount, nextCursor, or hasMore fields to determine if more data is available.
Use a consistent limit value across requests to avoid gaps or overlaps in paginated data.
For cursor-based endpoints, store the cursor from each response and pass it as a query parameter in the next request.
Avoid using very large limit values, as they can degrade API performance.

\n","_postman_id":"866b597f-4dd3-4ace-aca2-f18715e8cdee","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"Sorting","item":[{"name":"Sort by oldest matches","id":"56478ae1-d0ef-44a7-a82a-f285f121cb51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56478ae1-d0ef-44a7-a82a-f285f121cb51"},{"name":"Sort by newest matches","id":"5f9505e9-ff6c-4af7-b28b-e4de7d1d6da3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f9505e9-ff6c-4af7-b28b-e4de7d1d6da3"},{"name":"Sort by move count","id":"7638fcd6-eeaf-4fda-b7a5-e1f6885b36f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7638fcd6-eeaf-4fda-b7a5-e1f6885b36f8"},{"name":"Sort by longest games","id":"4b9146b3-e499-406e-8cca-dd22bb9bf003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b9146b3-e499-406e-8cca-dd22bb9bf003"},{"name":"Sort by duration","id":"e4f5611c-ff41-4277-ac57-685c95208d84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4f5611c-ff41-4277-ac57-685c95208d84"},{"name":"Sort by white player rating","id":"05f85484-a994-4f8a-b433-d1a601e6596a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"05f85484-a994-4f8a-b433-d1a601e6596a"},{"name":"Sort by black player rating","id":"87ab6954-848f-4160-9d2b-7b08e7ff8882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"87ab6954-848f-4160-9d2b-7b08e7ff8882"},{"name":"Sort by winner","id":"191306f6-3669-473a-8752-cd3b49ea8d88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"191306f6-3669-473a-8752-cd3b49ea8d88"},{"name":"Sort by time control","id":"6a450b50-eb4b-4e4f-91bc-a84c5c26cba5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a450b50-eb4b-4e4f-91bc-a84c5c26cba5"},{"name":"Sort by opening name","id":"64ecfbca-d6d2-4197-a929-8815060df87c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"64ecfbca-d6d2-4197-a929-8815060df87c"},{"name":"Sort by popularity","id":"396f1b29-cedc-43fb-b712-364c809ee482","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"396f1b29-cedc-43fb-b712-364c809ee482"},{"name":"Sort by engine accuracy","id":"606ff38d-95bf-4aa2-8737-d82637454e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"606ff38d-95bf-4aa2-8737-d82637454e59"},{"name":"Shortest matches first","id":"9cbd0643-a950-4eed-8119-749e4213705a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/shortest","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","sort","shortest"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cbd0643-a950-4eed-8119-749e4213705a"},{"name":"Longest matches first","id":"72c64daa-3979-4ad4-bf77-144191ee18a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/longest","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","sort","longest"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"72c64daa-3979-4ad4-bf77-144191ee18a9"},{"name":"Highest rated matches","id":"492efd01-1655-408f-a272-328168063574","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/highest-rated","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches","sort","highest-rated"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"492efd01-1655-408f-a272-328168063574"}],"id":"aa38650b-3f99-40dc-8cb2-9a631d778239","description":"

Sorting

This folder contains all sorting-related endpoints for the Chess Match Analytics API. These requests allow you to retrieve chess match records ordered by a variety of fields — from temporal data and game length to player ratings, openings, and engine accuracy. Both generic query-parameter-based sorting and dedicated sort endpoints are included.

Overview

The Chess Match Analytics API supports flexible sorting of match data through two mechanisms:

Query Parameter Sorting — Use GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches with sort, sortBy, and order query parameters to dynamically sort results by any supported field.
Dedicated Sort Endpoints — Pre-built endpoints under /api/v1/matches/sort/ that return matches sorted by a specific criterion without requiring query parameters.

Common Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`sort`	`string`	The field to sort results by (e.g., `date`, `moves`, `duration`, `rating`, `winner`, `opening`, `popularity`, `accuracy`)
`sortBy`	`string`	Alternative to `sort` — used in some endpoints to specify the sort field
`order`	`string`	Sort direction: `asc` for ascending, `desc` for descending

Requests

Query Parameter–Based Sorting (`GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches`)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

#	Request	Description
1	Sort by Oldest Matches	Returns matches sorted by date in ascending order (`sort=date&order=asc`), showing the earliest recorded games first.
2	Sort by Newest Matches	Returns matches sorted by date in descending order (`sort=date&order=desc`), showing the most recently played games first.
3	Sort by Move Count	Sorts matches by the total number of moves played (`sort=moves`), useful for identifying short tactical games vs. long endgames.
4	Sort by Longest Games	Returns matches ordered by move count descending (`sort=moves&order=desc`), surfacing the most complex, drawn-out games.
5	Sort by Duration	Sorts matches by total game duration (`sort=duration`), useful for analyzing time usage across different time controls.
6	Sort by White Player Rating	Orders matches by the Elo rating of the white player (`sort=whiteRating`), enabling analysis by skill level.
7	Sort by Black Player Rating	Orders matches by the Elo rating of the black player (`sort=blackRating`), enabling analysis by skill level.
8	Sort by Winner	Groups and sorts matches by the outcome/winner (`sort=winner`), making it easy to compare win distributions.
9	Sort by Time Control	Sorts matches by their time control setting (`sort=timeControl`), useful for filtering bullet, blitz, rapid, or classical games.
10	Sort by Opening Name	Alphabetically sorts matches by the chess opening played (`sort=opening`), helpful for studying specific opening repertoires.
11	Sort by Popularity	Orders matches by a popularity score (`sort=popularity`), surfacing the most-viewed or most-referenced games.
12	Sort by Engine Accuracy	Sorts matches by engine evaluation accuracy (`sort=accuracy`), useful for identifying the most precisely played games.

Dedicated Sort Endpoints

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

#	Request	Endpoint	Description
13	Shortest Matches First	`GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/shortest`	Returns matches sorted by move count ascending — the quickest games appear first.
14	Longest Matches First	`GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/longest`	Returns matches sorted by move count descending — the longest, most complex games appear first.
15	Highest Rated Matches	`GET https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/sort/highest-rated`	Returns matches sorted by the combined or average player rating descending — elite-level games appear first.

Available Sort Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`date`	Date the match was played
`moves`	Total number of moves in the game
`duration`	Total duration of the game
`whiteRating`	Elo rating of the white player
`blackRating`	Elo rating of the black player
`winner`	Match outcome / winning side
`timeControl`	Time control format (bullet, blitz, rapid, classical)
`opening`	Name of the chess opening used
`popularity`	Popularity score of the match
`accuracy`	Engine-evaluated accuracy score

","_postman_id":"aa38650b-3f99-40dc-8cb2-9a631d778239","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"HEAD & OPTIONS","item":[{"name":"OPTIONS /matches","id":"1e445424-42f4-4d92-a2e6-637d29c7b923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e445424-42f4-4d92-a2e6-637d29c7b923"},{"name":"OPTIONS /matches/:matchId","id":"d8e750eb-fe02-48b3-80b4-2f8f2d77e31a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches",":matchId"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[{"type":"any","key":"matchId"}]}},"response":[],"_postman_id":"d8e750eb-fe02-48b3-80b4-2f8f2d77e31a"},{"name":"OPTIONS /players","id":"57971131-aee4-4377-a9bf-6fdfef43725d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57971131-aee4-4377-a9bf-6fdfef43725d"},{"name":"OPTIONS /openings","id":"603d47bf-0a27-4f77-934b-2564025a3572","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"603d47bf-0a27-4f77-934b-2564025a3572"},{"name":"OPTIONS /search/matches","id":"e4dd3d99-4a4f-4c21-b7e5-fbd18c5aa340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","search","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4dd3d99-4a4f-4c21-b7e5-fbd18c5aa340"},{"name":"OPTIONS /auth/login","id":"5face1f7-250e-4f57-95dc-cbf3bc6eaf1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/auth/login","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","auth","login"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5face1f7-250e-4f57-95dc-cbf3bc6eaf1e"},{"name":"OPTIONS /admin/users","id":"aca9d13c-0a2a-42d4-92d0-4f7f7de39425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","admin","users"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aca9d13c-0a2a-42d4-92d0-4f7f7de39425"},{"name":"HEAD /matches","id":"2fa09f2f-ed83-4962-b9c0-ec79d48ff1b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"HEAD","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fa09f2f-ed83-4962-b9c0-ec79d48ff1b9"},{"name":"HEAD /matches/:matchId","id":"99e05e37-3704-451c-9bdd-d4e48381d464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"HEAD","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches",":matchId"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[{"type":"any","key":"matchId"}]}},"response":[],"_postman_id":"99e05e37-3704-451c-9bdd-d4e48381d464"},{"name":"HEAD /players","id":"be4ea2df-2ffe-4adb-aa88-2475732fabd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"HEAD","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","players"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"be4ea2df-2ffe-4adb-aa88-2475732fabd3"},{"name":"HEAD /openings","id":"75394659-6669-4eb0-a57a-34e1d3516cec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"HEAD","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","openings"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75394659-6669-4eb0-a57a-34e1d3516cec"},{"name":"HEAD /system/status","id":"21f86362-7ed2-4544-9b2b-051369dfe082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"HEAD","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/status","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","system","status"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"21f86362-7ed2-4544-9b2b-051369dfe082"}],"id":"a609dd73-a6e4-44b4-b971-dad57e1df901","description":"

HEAD & OPTIONS Methods

This folder contains requests that demonstrate the HEAD and OPTIONS HTTP methods across the Chess Match Analytics API. These methods are essential for efficient API communication, capability discovery, and CORS compliance — without transferring unnecessary response body data.

HTTP Method Overview

HEAD

The HEAD method is identical to GET, but the server returns only the response headers — no body. It is used to:

Check if a resource exists (via status code) without downloading its content
Retrieve metadata such as Content-Type, Content-Length, Last-Modified, or ETag
Validate caches and check for resource updates efficiently
Perform lightweight health or availability checks

OPTIONS

The OPTIONS method is used to discover the communication capabilities of a resource or server. It is used to:

Retrieve the list of HTTP methods allowed on a specific endpoint (via the Allow header)
Perform CORS preflight requests — browsers automatically send OPTIONS before cross-origin requests to verify that the server permits the operation
Inspect supported headers, content types, and authentication requirements without side effects

Both methods are safe (they do not modify server state) and idempotent (repeated calls produce the same result).

Requests in This Folder

OPTIONS Requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

#	Request	Endpoint	Purpose
1	OPTIONS /matches	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches`	Discover allowed methods and CORS policy for the matches collection endpoint
2	OPTIONS /matches/:matchId	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId`	Discover allowed methods for a specific match resource
3	OPTIONS /players	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players`	Retrieve supported methods and CORS headers for the players endpoint
4	OPTIONS /openings	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings`	Check allowed operations on the chess openings endpoint
5	OPTIONS /search/matches	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/search/matches`	Inspect CORS and method support for the match search endpoint
6	OPTIONS /auth/login	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/auth/login`	Verify allowed methods and preflight CORS for the authentication login endpoint
7	OPTIONS /admin/users	`OPTIONS https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/admin/users`	Discover allowed methods and access policies for the admin users endpoint

HEAD Requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

#	Request	Endpoint	Purpose
8	HEAD /matches	`HEAD https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches`	Check existence and retrieve metadata (e.g., `Content-Length`, `ETag`) for the matches collection without fetching the body
9	HEAD /matches/:matchId	`HEAD https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches/:matchId`	Verify that a specific match exists and retrieve its headers
10	HEAD /players	`HEAD https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/players`	Retrieve response headers for the players endpoint to check availability and metadata
11	HEAD /openings	`HEAD https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/openings`	Check the openings endpoint for availability and content metadata
12	HEAD /system/status	`HEAD https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/system/status`	Perform a lightweight system health check — confirms the API is reachable without parsing a response body

Common Response Headers to Inspect

When working with these requests, pay attention to the following response headers:

Allow — Lists the HTTP methods permitted on the endpoint (returned by OPTIONS)
Access-Control-Allow-Origin — Indicates which origins are permitted (CORS)
Access-Control-Allow-Methods — Lists methods allowed in cross-origin requests
Access-Control-Allow-Headers — Specifies which request headers are allowed
Content-Type — The media type of the resource
Content-Length — The size of the response body (useful in HEAD requests)
ETag / Last-Modified — Cache validation headers

Variable Reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`https://chess-game-dataset-harshit-kumar.onrender.com`	The base URL of the Chess Match Analytics API (e.g., `http://localhost:3000`)
`:matchId`	The unique identifier of a chess match

","_postman_id":"a609dd73-a6e4-44b4-b971-dad57e1df901","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}},{"name":"HEAD & OPTIONS","item":[{"name":"OPTIONS Matches","id":"6afe471f-fadf-4149-9c27-070dbd8bb943","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6afe471f-fadf-4149-9c27-070dbd8bb943"},{"name":"HEAD Matches","id":"22350a10-82a2-4459-b402-ba02672a8875","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"HEAD","header":[],"url":"https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}},"urlObject":{"path":["api","v1","matches"],"host":["https://chess-game-dataset-harshit-kumar.onrender.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"22350a10-82a2-4459-b402-ba02672a8875"}],"id":"40863e25-7e02-48fa-8b82-f1b656c79537","description":"

HEAD & OPTIONS

This folder contains requests that use the HEAD and OPTIONS HTTP methods against the /api/v1/matches endpoint. These methods are essential for API introspection, capability discovery, and efficient metadata retrieval without transferring response bodies.

HEAD Method

The HEAD method is identical to GET, but the server does not return a response body. Only the response headers are returned. This makes HEAD requests highly efficient for:

Checking resource existence — verify a resource is available without downloading its content.
Inspecting metadata — retrieve headers such as Content-Type, Content-Length, Last-Modified, or ETag.
Cache validation — determine whether a cached resource is still fresh before making a full GET request.
Bandwidth optimization — useful in scenarios where only header information is needed.

OPTIONS Method

The OPTIONS method is used to describe the communication options available for a target resource. It is commonly used for:

Discovering allowed HTTP methods — the server responds with an Allow header listing the methods supported on the endpoint (e.g., GET, POST, PUT, DELETE, HEAD, OPTIONS).
CORS preflight requests — browsers automatically send an OPTIONS request before cross-origin requests to verify that the server permits the actual request. The server responds with CORS headers such as Access-Control-Allow-Origin, Access-Control-Allow-Methods, and Access-Control-Allow-Headers.
API capability discovery — clients can programmatically determine what operations are permitted on a resource without attempting them.

Requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Request	Method	Endpoint	Description
OPTIONS Matches	`OPTIONS`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches`	Retrieves the communication options for the matches endpoint. Returns the allowed HTTP methods and CORS-related headers, enabling capability discovery and preflight validation.
HEAD Matches	`HEAD`	`https://chess-game-dataset-harshit-kumar.onrender.com/api/v1/matches`	Fetches only the response headers for the matches collection — no body is returned. Useful for checking availability, content metadata, and cache freshness of the matches resource.

\n
Note: Use https://chess-game-dataset-harshit-kumar.onrender.com as the base URL variable, configured in your active Postman environment, to point these requests at the correct server (e.g., http://localhost:3000 for local development).
\n

\n","_postman_id":"40863e25-7e02-48fa-8b82-f1b656c79537","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]},"isInherited":true,"source":{"_postman_id":"d095997f-866b-41ee-91f4-a38e92f51650","id":"d095997f-866b-41ee-91f4-a38e92f51650","name":"Chess Match Analytics API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{json_web_token_0tq4}}"}]}},"event":[{"listen":"prerequest","script":{"id":"3d1b0fc4-2c3f-4f99-b24e-60b4816a55b9","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"e0bc426c-2e8d-4f41-bd44-9cca50a0412d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://chess-game-dataset-harshit-kumar.onrender.com"},{"key":"json_web_token_0tq4","secret":true},{"key":"auth_secret_0fch","secret":true},{"key":"auth_secret_0tq4","secret":true},{"key":"bearer_token_0i4p","secret":true}]}

♟️ Chess Match Analytics API

🌐 Base URL

🔐 Authentication

🚀 Getting Started

📁 Folder Overview

📦 Match Object Fields

💡 Tips

Register a New Account

Request Body (JSON)

Response

Login

Request Body (JSON)

Response

Get My Profile

Response

Get All Matches

Query Parameters

Response

Get Match By ID

Path Parameters

Response

Create a New Match

Request Body (JSON)

Response

Update a Match

Path Parameters

Request Body (JSON) — send only the fields you want to update

Response

Delete a Match

Path Parameters

Response

Filter Rated Matches

Response

Filter Unrated Matches

Response

Filter White Wins

Response

Filter Black Wins

Response

Filter Checkmates

Response

Sort by Longest Games

Response

Sort by Shortest Games

Response

Sort by Highest Rated

Response

Get Match Moves

Path Parameters

Response

Get Match PGN

Path Parameters

Response

Get Match FEN

Path Parameters

Response

Get Match Engine Analysis

Path Parameters

Response

Get Latest Matches

Query Parameters

Response

Get Trending Matches

Query Parameters

Response

Get a Random Match

Response

Archive a Match

Path Parameters

Response

Restore a Match

Path Parameters

Response

Filter Drawn Games

Response

Filter Resignation Games

Response

Filter Timeout Games

Response

Filter Rapid Games