LichessSharp 0.2.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package LichessSharp --version 0.2.1
                    


                    

                
NuGet\Install-Package LichessSharp -Version 0.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="LichessSharp" Version="0.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="LichessSharp" Version="0.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="LichessSharp" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add LichessSharp --version 0.2.1
                    


                    

                
#r "nuget: LichessSharp, 0.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package LichessSharp@0.2.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=LichessSharp&version=0.2.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=LichessSharp&version=0.2.1
                    


                            Install as a Cake Tool

LichessSharp

A fully-featured .NET client library for the Lichess API.

NuGet License: MIT

Features

  • Complete API coverage - 23 API areas with 176 endpoints fully implemented
  • Async-first design - All methods return Task<T> with full CancellationToken support
  • Real-time streaming - IAsyncEnumerable<T> for NDJSON streams (games, TV, tournaments, events)
  • Strong typing - Comprehensive models and enums matching Lichess semantics
  • Resilient by default - Built-in retry logic for rate limits (HTTP 429) and transient network failures
  • DI-friendly - Works seamlessly with HttpClientFactory and dependency injection
  • Modern .NET - Targets .NET 10.0, uses System.Text.Json with AOT preparation

Installation

dotnet add package LichessSharp

Quick Start

using LichessSharp;

// Create a client (unauthenticated for public API)
using var client = new LichessClient();

// Or with an access token for authenticated endpoints
using var authenticatedClient = new LichessClient("your-access-token");

// Access different API areas
var user = await client.Users.GetAsync("DrNykterstein");
var game = await client.Games.GetAsync("q7ZvsdUF");
var puzzle = await client.Puzzles.GetDailyAsync();

Documentation

Full Documentation - Complete guides and API reference

Samples

Run the interactive samples to explore common usage patterns:

cd samples/LichessSharp.Samples
dotnet run

Includes examples for client setup, streaming, Board API, bot development, and error handling.

Error Handling

try
{
    var user = await client.Users.GetAsync("nonexistent");
}
catch (LichessNotFoundException) { /* User not found */ }
catch (LichessRateLimitException ex) { /* Retry after ex.RetryAfter */ }
catch (LichessAuthorizationException ex) { /* Missing scope: ex.RequiredScope */ }

Contributing

Contributions welcome! See CONTRIBUTING.md for guidelines.

License

MIT License - see LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 163 3/24/2026
0.5.1 122 3/23/2026
0.5.0 124 3/13/2026
0.4.1 122 3/3/2026
0.4.0 129 2/24/2026
0.3.1 157 1/20/2026
0.3.0 126 1/20/2026
0.2.1 135 1/20/2026
0.2.0 198 12/20/2025
0.1.0 190 12/20/2025

See https://github.com/Dblike/LichessSharp/blob/main/CHANGELOG.md for release notes.