Lichess

The Lichess integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to monitor your Lichess chess statistics in Home Assistant.

Prerequisites

You need a Lichess personal API token to use this integration. You can create one on the Lichess API token page.

Configuration

To add the Lichess service to your Home Assistant instance, use this My button:

Generate an API token

The API token is used to authenticate requests to the Lichess API. To generate an API token, take the following steps:

1. Visit the Lichess API token page.
2. When creating the token, make sure Read preferences is allowed.

Supported functionality

Sensors

The integration creates sensors for your rating in Bullet, Blitz, Rapid, and Classical, and also the number of games played in each of these formats.

Entities for your rating and the number of games played in the following formats are also available, but are disabled by default:

• Puzzles
• Ultra Bullet
• Correspondence
• Chess960
• Crazyhouse
• Antichess
• Atomic
• Horde
• King of the Hill
• Racing Kings
• Three-check

Data updates

The integration pollsData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] the Lichess API every hour to update sensor data.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

1. Go to Settings > Devices & services and select the integration card.
2. Next to the entry you want to remove, select the three dots menu. Then, select Delete.
   • Depending on the integration, the entries are listed under one of the following headings:
     • Devices
     • Hubs
     • Services
     • Integration entries
3. To confirm, select Delete.
   • Home Assistant also deletes the devices and entities of the entry.
4. If Home Assistant asks you to restart, restart Home Assistant.
5. If Home Assistant asks whether to also delete the application credentials, select Remove or Keep.
   • If you keep them, Home Assistant uses them automatically when you add the integration again.
   • To delete them later, refer to Deleting application credentials.