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:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Lichess.
-
Follow the instructions on screen to complete the setup.
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:
- Visit the Lichess API token page.
- 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.
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
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.