# Chess.com Scraper (`crawlerbros/chess-com-scraper`) Actor Scrape Chess.com - leaderboards, player profiles, stats, and game archives. Fully public API, zero credentials required. - **URL**: https://apify.com/crawlerbros/chess-com-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Automation, Developer tools, Integrations - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Chess.com Scraper Scrape **Chess.com** — the world's largest chess platform with 100M+ members. Extract leaderboards, player profiles, ratings, and game archives via the fully public Chess.com API. No API key or credentials required. ### What you can scrape - **Global leaderboards** — Top players across Rapid, Blitz, Bullet, Daily, Chess960, Tactics, and more - **Player profiles** — Username, title (GM/IM/FM), country, bio, followers, streaming status - **Player stats** — Current and best ratings across all game types - **Game archives** — Full game history with PGN notation, ratings, results ### Output fields #### Leaderboard entries | Field | Description | |---|---| | `username` | Chess.com username | | `title` | Chess title (GM, IM, FM, NM, etc.) | | `country` | ISO country code | | `score` | Leaderboard rating/score | | `rank` | Position on leaderboard | | `gameType` | Game type identifier | | `gameTypeLabel` | Human-readable game type | | `sourceUrl` | Link to player profile | #### Player profiles | Field | Description | |---|---| | `name` | Full display name | | `bio` | Player biography | | `location` | Location string | | `followers` | Follower count | | `isStreamer` | Whether player streams | | `joinedAt` | Account creation date (ISO 8601) | | `lastOnlineAt` | Last seen date (ISO 8601) | #### Game records | Field | Description | |---|---| | `whiteUsername` | White player | | `blackUsername` | Black player | | `whiteRating` | White player rating | | `blackRating` | Black player rating | | `winner` | `white`, `black`, or `draw` | | `timeClass` | `rapid`, `blitz`, `bullet`, `daily` | | `rated` | Whether game was rated | | `endedAt` | Game end timestamp | | `pgn` | Full PGN notation | ### Input options | Field | Type | Description | |---|---|---| | `mode` | select | `leaderboard`, `player`, `playerStats`, `playerGames` | | `gameType` | select | Leaderboard type (Rapid, Blitz, Bullet, etc.) | | `username` | string | Chess.com username for player modes | | `year` | integer | Year for game archive | | `month` | integer | Month 1-12 for game archive | | `maxItems` | integer | Max records (1–1000) | ### Example use cases 1. **Player ranking** — Get top 50 rapid chess players worldwide 2. **Profile lookup** — Scrape rating history for a specific player 3. **Game analysis** — Download PGN archives for analysis 4. **Market research** — Identify top streamers and their follower counts ### FAQ **Does this require an API key?** No. Chess.com's API is completely public with no authentication. **How many leaderboard entries are returned?** Chess.com returns up to 50 entries per leaderboard type. **Can I get game PGN data?** Yes. The `playerGames` mode returns full PGN notation for each game. **What game types are available?** Rapid, Blitz, Bullet, Daily, Chess960 Daily, Bughouse, Blitz960, Three-Check, Crazyhouse, King of the Hill, Tactics, Puzzle Rush, and Battle. # Actor input Schema ## `mode` (type: `string`): What to fetch from Chess.com. ## `gameType` (type: `string`): Which leaderboard to fetch. ## `username` (type: `string`): Chess.com username for player/playerStats/playerGames modes. ## `year` (type: `integer`): Year of games to fetch (e.g. 2024). Defaults to current year. ## `month` (type: `integer`): Month 1–12. If omitted with year, fetches all months. ## `maxItems` (type: `integer`): Hard cap on emitted records. ## Actor input object example ```json { "mode": "leaderboard", "gameType": "live_rapid", "username": "hikaru", "maxItems": 50 } ```` # Actor output Schema ## `chess_data` (type: `string`): Dataset of scraped Chess.com records. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "leaderboard", "gameType": "live_rapid", "username": "hikaru", "maxItems": 50 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/chess-com-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "leaderboard", "gameType": "live_rapid", "username": "hikaru", "maxItems": 50, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/chess-com-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "leaderboard", "gameType": "live_rapid", "username": "hikaru", "maxItems": 50 }' | apify call crawlerbros/chess-com-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/chess-com-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Chess.com Scraper", "description": "Scrape Chess.com - leaderboards, player profiles, stats, and game archives. Fully public API, zero credentials required.", "version": "1.0", "x-build-id": "D6elc2CwoK4lLTNxU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~chess-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-chess-com-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~chess-com-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-chess-com-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~chess-com-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-chess-com-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "leaderboard", "player", "playerStats", "playerGames" ], "type": "string", "description": "What to fetch from Chess.com.", "default": "leaderboard" }, "gameType": { "title": "Game type (mode=leaderboard)", "enum": [ "live_rapid", "live_blitz", "live_bullet", "daily", "daily960", "live_bughouse", "live_blitz960", "live_threecheck", "live_crazyhouse", "live_kingofthehill", "tactics", "rush", "battle" ], "type": "string", "description": "Which leaderboard to fetch.", "default": "live_rapid" }, "username": { "title": "Username (player modes)", "type": "string", "description": "Chess.com username for player/playerStats/playerGames modes." }, "year": { "title": "Year (mode=playerGames)", "minimum": 2000, "maximum": 2030, "type": "integer", "description": "Year of games to fetch (e.g. 2024). Defaults to current year." }, "month": { "title": "Month (mode=playerGames)", "minimum": 1, "maximum": 12, "type": "integer", "description": "Month 1–12. If omitted with year, fetches all months." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```