This software stopped working after late July 2025 when Habitica started enforcing x-client requirements.
Information about the API change can be found at Application Programming Interface.
Description
This component will enable you to track the following attributes in Home Assistant (Hass):
- Name
- Level
- Class
- Gold
- Experience (EXP) and Next Level Experience
- Health Points (HP) and maximum HP
- Mana and maximum Mana
What can you do with it?
You can react on status changes using Hass. Your Hass instance could trigger changes using the REST component (not related to this integration) based on stats within the Home Automation. You can plot your data for example using Grafana out of the box.
Installation
Copy the habitica.py file to your configuration path like so:
<config_dir>/custom_components/sensor/habitica.py
Usage
You need your User ID and API Token which you can find at Settings > API on the website or Settings > Authentication on the official Android and iOS apps.
platform: habitica api_user: <your_api_user_id> api_key: <your_api_key>
