crawlora / lichess
Crawlora Lichess API client with 11 endpoints for puzzles, tablebases, tournaments, cloud evaluations, and public event listings
Requires
- php: >=8.1
- ext-curl: *
- ext-json: *
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Official Crawlora client packages for the hosted Lichess API. Access 11 API endpoints covering puzzles, tablebases, tournaments, cloud evaluations, and public event listings from JavaScript/TypeScript, Python, Go, Ruby, Java, PHP, and Rust. These clients call Crawlora's hosted API; they do not scrape Lichess locally. Requests use your Crawlora account and CRAWLORA_API_KEY; service usage follows your account billing plan. Crawlora is independent from and not affiliated with or endorsed by Lichess or its owners.
Language packages
- JavaScript / TypeScript:
@crawlora-org/lichess - Python:
crawlora-lichess - Go:
github.com/Crawlora-org/crawlora-lichess - Ruby:
crawlora-lichess - Java:
net.crawlora:crawlora-lichess:0.1.0 - PHP:
crawlora/lichess - Rust:
crawlora-lichess
For installation and runnable examples, use the README for your language. See the API endpoint and parameter reference for shared operation details.
Create an account at crawlora.net, open the Crawlora console to get an API key, or read the API documentation. Keep CRAWLORA_API_KEY out of source control.
API coverage and supported endpoints
The seven language clients provide access to all 11 selected public Lichess API operations. Search or browse by endpoint path and operation ID below; the complete API reference adds parameters, enums, and response details.
| Method | Endpoint | API operation | Description |
|---|---|---|---|
GET |
/lichess/cloud-eval |
lichess-cloud-eval |
Get a cached Lichess cloud evaluation |
GET |
/lichess/enums |
lichess-enums |
List Lichess public read enums |
GET |
/lichess/puzzle |
lichess-puzzle |
Get a public Lichess puzzle |
GET |
/lichess/puzzle/batch |
lichess-puzzle-batch |
Get a Lichess puzzle batch by theme |
GET |
/lichess/puzzle/daily |
lichess-puzzle-daily |
Lichess daily puzzle |
GET |
/lichess/puzzle/many |
lichess-puzzle-many |
Get multiple Lichess puzzles by ID |
GET |
/lichess/puzzle/next |
lichess-puzzle-next |
Get a Lichess puzzle by source filters |
GET |
/lichess/puzzle/themes |
lichess-puzzle-themes |
Discover Lichess puzzle themes |
GET |
/lichess/simuls |
lichess-simuls |
List public Lichess simultaneous exhibitions |
GET |
/lichess/tablebase |
lichess-tablebase |
Query the Lichess tablebase |
GET |
/lichess/version |
lichess-version |
Get the Lichess server version |
License
MIT. See LICENSE.