# Lichess Scraper (`crawlerbros/lichess-scraper`) Actor Scrape Lichess - the world's most popular open-source chess platform with 3M+ daily games. Leaderboards by game type, player profiles with ratings, and daily puzzles. - **URL**: https://apify.com/crawlerbros/lichess-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Automation, Developer tools - **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 ## Lichess Scraper Scrape **Lichess** — the world's most popular free and open-source chess platform with 3M+ daily games and 100M+ registered players. Get leaderboards across 14 game variants, player profiles with full rating history, and daily chess puzzles. Fully public API, no authentication required. ### What you can scrape - **Leaderboards** — Top players by game type (Bullet, Blitz, Rapid, Classical, Chess960, and 9 more variants) - **Player profiles** — Username, title (GM/IM/FM), ratings across all variants, country, bio - **Daily puzzle** — Today's featured puzzle with rating, themes, and FEN position ### Output fields #### Leaderboard entries | Field | Description | |---|---| | `username` | Lichess username | | `title` | Chess title (GM, IM, FM, NM, etc.) | | `rating` | Current rating for the selected variant | | `ratingProgress` | Rating change (positive/negative) | | `rank` | Position on leaderboard | | `perfType` | Game variant name | | `sourceUrl` | Link to player profile | #### Player profiles | Field | Description | |---|---| | `bio` | Player biography | | `country` | Country code (ISO 3166-1 alpha-2) | | `followers` | Number of followers | | `completionRate` | Game completion rate % | | `rating_bullet` | Bullet rating | | `rating_blitz` | Blitz rating | | `rating_rapid` | Rapid rating | | `games_bullet` | Bullet games played | | `createdAt` | Account creation date | #### Puzzles | Field | Description | |---|---| | `puzzleId` | Lichess puzzle ID | | `rating` | Puzzle difficulty rating | | `plays` | Number of times solved | | `themes` | Tactical themes (fork, pin, etc.) | | `fen` | Board position in FEN notation | ### Input options | Field | Type | Description | |---|---|---| | `mode` | select | `leaderboard`, `player`, `dailyPuzzle` | | `perfType` | select | 14 game variants (bullet, blitz, rapid, chess960, etc.) | | `username` | string | Lichess username (for player mode) | | `maxItems` | integer | Max leaderboard entries (1–200) | ### Game variants available Bullet, Blitz, Rapid, Classical, Correspondence, Ultra Bullet, Chess960, Crazyhouse, Antichess, Atomic Chess, Horde, King of the Hill, Racing Kings, Three-Check ### FAQ **Does this require a Lichess account?** No. All leaderboard and profile data is publicly accessible without authentication. **How many players can I get from a leaderboard?** Up to 200 top players per variant per run. **What chess titles are available?** GM (Grandmaster), IM (International Master), FM (FIDE Master), NM (National Master), BOT (chess bots), WGM, WIM, WFM, WNM (women's titles). # Actor input Schema ## `mode` (type: `string`): What to fetch from Lichess. ## `perfType` (type: `string`): Chess variant for the leaderboard. ## `username` (type: `string`): Lichess username to fetch profile for. ## `maxItems` (type: `integer`): Max leaderboard entries (1–200). ## Actor input object example ```json { "mode": "leaderboard", "perfType": "bullet", "username": "DrNykterstein", "maxItems": 50 } ```` # Actor output Schema ## `chess_data` (type: `string`): Dataset of Lichess 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", "perfType": "bullet", "username": "DrNykterstein", "maxItems": 50 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/lichess-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", "perfType": "bullet", "username": "DrNykterstein", "maxItems": 50, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/lichess-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", "perfType": "bullet", "username": "DrNykterstein", "maxItems": 50 }' | apify call crawlerbros/lichess-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/lichess-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Lichess Scraper", "description": "Scrape Lichess - the world's most popular open-source chess platform with 3M+ daily games. Leaderboards by game type, player profiles with ratings, and daily puzzles.", "version": "1.0", "x-build-id": "szItemOKXgL8e02g0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~lichess-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-lichess-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~lichess-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-lichess-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~lichess-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-lichess-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", "dailyPuzzle" ], "type": "string", "description": "What to fetch from Lichess.", "default": "leaderboard" }, "perfType": { "title": "Game type (mode=leaderboard)", "enum": [ "ultraBullet", "bullet", "blitz", "rapid", "classical", "correspondence", "chess960", "crazyhouse", "antichess", "atomic", "horde", "kingOfTheHill", "racingKings", "threeCheck" ], "type": "string", "description": "Chess variant for the leaderboard.", "default": "bullet" }, "username": { "title": "Username (mode=player)", "type": "string", "description": "Lichess username to fetch profile for." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Max leaderboard entries (1–200).", "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 } } } } } } } } } } ```