Skip to content

ion232/lichess-api

Repository files navigation

lichess-api

Crates.io Dependencies Documentation Apache 2.0 licensed

A Rust API client library for the current lichess.org API.

The goal of this crate is to fully support the latest lichess API - a major version release will be made once all endpoints are supported.

The lichess endpoints will often change without an OpenAPI version or even schema change, so please raise an issue with relevant output if one of the endpoints is failing.

Endpoints

  • βœ… = Fully supported at the time of the most recent release crate.
  • πŸ”Ά = Partially supported.
  • 🚧 = Work to support this category is currently in progress.
  • ❌ = Not currently supported.

The following table shows the current level of support for each category of endpoints.

Category Status
Account βœ…
Analysis βœ…
Arena Tournaments ❌
Board βœ…
Bot βœ…
Broadcasts ❌
Bulk Pairings ❌
Challenges βœ…
External Engine πŸ”Ά
Games βœ…
Messaging βœ…
Opening Explorer βœ…
OAuth ❌
Puzzles βœ…
Relations ❌
Simuls βœ…
Studies πŸ”Ά
Swiss Tournaments ❌
Tablebase βœ…
Teams ❌
TV βœ…
Users βœ…

Contributing

Contributions are much appreciated - especially if you can add support for a category of endpoints. Otherwise, if you have any ideas, bug reports, feature requests, or fixes, please make an issue or submit a pull request.

Thanks.