v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB

Users

Get live streamers

Get basic info about currently streaming users. This API is very fast and cheap on lichess side. So you can call it quite often (like once every 5 seconds).

get/api/streamer/live

Response

The list of live streamers and their respective information.

idstring required

namestring required

flairstring

See available flair list and images

title'GM' | 'WGM' | 'IM' | 'WIM' | 'FM' | 'WFM' | 'NM' | 'CM' | 'WCM' | 'WNM' | 'LM' | 'BOT'

only appears if the user is a titled player or a bot user

patronboolean

Use patronColor value instead to determine if player is a patron.

patronColorinteger

Players can choose a color for their Patron wings. See here for the color mappings.

The presence of this field indicates the player is an active Patron.