Broadcasts

Broadcasts API

Relay chess events on Lichess. Broadcasts are organized in tournaments, which have several rounds, which have several games.

Namespace: LichessSharp.Api.Contracts Access: client.Broadcasts

Browsing Broadcasts

StreamOfficialBroadcastsAsync

Stream ongoing official broadcasts sorted by tier, followed by finished broadcasts.

IAsyncEnumerable<BroadcastWithRounds> StreamOfficialBroadcastsAsync(
    int? nb = null,
    bool? html = null,
    CancellationToken cancellationToken = default)

Parameters:

Name	Type	Description
nb	int?	Max broadcasts to fetch (1-100, default 20)
html	bool?	Convert description from markdown to HTML

Example:

using var client = new LichessClient();

await foreach (var broadcast in client.Broadcasts.StreamOfficialBroadcastsAsync(nb: 10))
{
    Console.WriteLine($"Tournament: {broadcast.Tour.Name}");
    Console.WriteLine($"  URL: {broadcast.Tour.Url}");

    if (broadcast.Tour.Info != null)
    {
        Console.WriteLine($"  Location: {broadcast.Tour.Info.Location}");
        Console.WriteLine($"  Time Control: {broadcast.Tour.Info.TimeControl}");
    }

    Console.WriteLine($"  Rounds: {broadcast.Rounds.Count}");
    foreach (var round in broadcast.Rounds.Take(3))
    {
        var status = round.Ongoing == true ? "LIVE" : (round.Finished == true ? "Finished" : "Upcoming");
        Console.WriteLine($"    - {round.Name} [{status}]");
    }
}

GetTopBroadcastsAsync

Get paginated top broadcast previews.

Task<BroadcastTopPage> GetTopBroadcastsAsync(
    int? page = null,
    CancellationToken cancellationToken = default)

Example:

using var client = new LichessClient();

var top = await client.Broadcasts.GetTopBroadcastsAsync(page: 1);

Console.WriteLine("Active Broadcasts:");
foreach (var broadcast in top.Active ?? [])
{
    Console.WriteLine($"  {broadcast.Tour.Name}");
    if (broadcast.Round?.Ongoing == true)
    {
        Console.WriteLine($"    LIVE: {broadcast.Round.Name}");
    }
}

Console.WriteLine("\nPast Broadcasts:");
foreach (var broadcast in top.Past?.CurrentPageResults ?? [])
{
    Console.WriteLine($"  {broadcast.Tour.Name}");
}

if (top.Past?.NextPage != null)
{
    Console.WriteLine($"\nMore on page {top.Past.NextPage}");
}

StreamUserBroadcastsAsync

Stream broadcasts created by a user.

IAsyncEnumerable<BroadcastByUser> StreamUserBroadcastsAsync(
    string username,
    int? nb = null,
    bool? html = null,
    CancellationToken cancellationToken = default)

Example:

using var client = new LichessClient();

await foreach (var broadcast in client.Broadcasts.StreamUserBroadcastsAsync("someuser", nb: 20))
{
    Console.WriteLine($"{broadcast.Tour.Name} - {broadcast.Tour.Url}");
}

SearchBroadcastsAsync

Search across recent official broadcasts.

Task<BroadcastSearchPage> SearchBroadcastsAsync(
    string query,
    int? page = null,
    CancellationToken cancellationToken = default)

Example:

using var client = new LichessClient();

var results = await client.Broadcasts.SearchBroadcastsAsync("World Championship");

Console.WriteLine($"Found broadcasts (page {results.CurrentPage}):");
foreach (var broadcast in results.CurrentPageResults ?? [])
{
    Console.WriteLine($"  {broadcast.Tour.Name}");
}

Getting Broadcast Details

GetTournamentAsync

Get information about a broadcast tournament.

Task<BroadcastWithRounds> GetTournamentAsync(
    string broadcastTournamentId,
    bool? html = null,
    CancellationToken cancellationToken = default)

Example:

using var client = new LichessClient();

var tournament = await client.Broadcasts.GetTournamentAsync("tournamentId");

Console.WriteLine($"Tournament: {tournament.Tour.Name}");
Console.WriteLine($"Description: {tournament.Tour.Description}");

foreach (var round in tournament.Rounds)
{
    Console.WriteLine($"Round: {round.Name}");
    Console.WriteLine($"  URL: {round.Url}");
    Console.WriteLine($"  Ongoing: {round.Ongoing}");
}

GetRoundAsync

Get information about a broadcast round with games.

Task<BroadcastRound> GetRoundAsync(
    string broadcastTournamentSlug,
    string broadcastRoundSlug,
    string broadcastRoundId,
    CancellationToken cancellationToken = default)

Example:

using var client = new LichessClient();

var round = await client.Broadcasts.GetRoundAsync(
    "world-championship-2024",
    "round-1",
    "roundId123");

Console.WriteLine($"Round: {round.Round.Name}");
Console.WriteLine($"Games:");

foreach (var game in round.Games)
{
    var white = game.Players?.FirstOrDefault();
    var black = game.Players?.Skip(1).FirstOrDefault();

    Console.WriteLine($"  {white?.Title} {white?.Name} vs {black?.Title} {black?.Name}");
    Console.WriteLine($"    Status: {game.Status}");
    Console.WriteLine($"    FEN: {game.Fen}");
}

StreamMyRoundsAsync

Stream all broadcast rounds you are a member of.

Required Scope: study:read

IAsyncEnumerable<BroadcastMyRound> StreamMyRoundsAsync(
    int? nb = null,
    CancellationToken cancellationToken = default)

Example:

using var client = new LichessClient(token);

await foreach (var myRound in client.Broadcasts.StreamMyRoundsAsync())
{
    Console.WriteLine($"Tournament: {myRound.Tour.Name}");
    Console.WriteLine($"Round: {myRound.Round.Name}");
    Console.WriteLine($"Can edit: {myRound.Study.Writeable}");
}