HomeAssistant-OctopusEnergy is a free, MIT-licensed custom Home Assistant integration that brings Octopus Energy UK account data — electricity and gas consumption, rates, and tariff information — into a home automation system so households can monitor and automate their energy use.
What it is
HomeAssistant-OctopusEnergy is a Python custom component built from the ground up to bring Octopus Energy details into Home Assistant, the open-source home automation platform. It lives in the Home Assistant custom integration ecosystem, which means it is not shipped with Home Assistant itself but installed alongside it, either through HACS or by copying its files into the custom_components directory. The integration is community-maintained, is in no way affiliated with Octopus Energy, and is built against the API provided by Octopus Energy UK. It has not been tested for any other country, so its behaviour assumes a UK account and UK tariff structures.
The concrete problem it solves is the gap between the Octopus Energy account view and the automation engine. Octopus Energy exposes consumption, rate, and tariff data, but acting on that data inside Home Assistant normally means hand-writing REST sensors, template sensors, and cost calculations, then keeping them in step with tariff changes and half-hourly rate windows. This integration replaces that manual wiring. Instead of building and maintaining custom sensors against the Octopus Energy API, a user adds the integration, authenticates an account, and gets entities for meters, consumption, rates, and derived costs that automations, dashboards, and the energy dashboard can consume directly.
Key capabilities
- Electricity and gas meter support, including consumption data and rate information exposed as Home Assistant entities.
- Cost tracker custom sensor support for tracking the costs of other entities, not only Octopus-supplied meters.
- Tariff comparison custom sensor support for comparing the current tariff against other tariffs.
- Octopus Home Mini support for accounts that use the Home Mini hardware.
- Intelligent tariff settings support, covering the sensor set for Octopus Intelligent tariffs.
- Saving sessions support through the Octoplus entity set.
- Heat Pump support, alongside Wheel of Fortune support for the Octopus game.
Who uses it and how
- Home Assistant households on Octopus Energy UK tariffs that want consumption and rate history in one dashboard rather than in the Octopus Energy app.
- Owners of electric vehicles on an Intelligent tariff, who use the existing Intelligent entity set to drive charging automations from tariff and rate state.
- Home Mini owners, who add the Home Mini to an account to get finer-grained consumption into their automations.
- Cost-conscious users who attach the cost tracker sensor to arbitrary devices, such as a standalone appliance, to price its running cost using Octopus rates.
- Heat pump owners and Octoplus participants, who surface saving sessions and heat pump data as entities that other automations can react to.
Getting started
The recommended path is HACS: add the repository to a HACS installation and click Download. Manual installation takes the latest published release and places the contents of custom_components into the custom_components folder of the Home Assistant installation, followed by a Home Assistant restart; the setup guide then walks through account configuration.
How it compares
No paid products or competing integrations are named in the facts provided, so this project stands alone in this registry as the entry covering Octopus Energy data inside Home Assistant. Any comparison would have to be made against the manual alternative of configuring REST and template sensors by hand, which is the workflow it replaces.
When to use it — and when not to
This is a good fit for someone already running Home Assistant with a UK Octopus Energy account who wants consumption, rate, and cost entities without maintaining custom sensors. It is a poor fit for anyone outside the UK, since it targets the Octopus Energy UK API and has not been tested elsewhere, and for anyone who needs a vendor-supported integration with a service commitment, because it is unofficial and unaffiliated. Prospective users should also note the 59 open issues, install from a published release rather than the develop branch, and expect to follow the documentation site and FAQ before raising a discussion or issue.
project readme (upstream, from github) — read inline
Home Assistant Octopus Energy
Custom component built from the ground up to bring your Octopus Energy details into Home Assistant to help you towards a more energy efficient (and or cheaper) home. This integration is built against the API provided by Octopus Energy UK and has not been tested for any other countries.
This integration is in no way affiliated with Octopus Energy.
If you find this useful and are planning on moving to Octopus Energy, why not use my referral link?
Features
Below are the main features of the integration
How to install
There are multiple ways of installing the integration. Once you've installed the integration, you'll need to setup your account before you can use the integration.
HACS
This integration can be installed directly via HACS. To install:
Manual
You should take the latest published release. The current state of develop will be in flux and therefore possibly subject to change.
To install, place the contents of custom_components into the /custom_components folder of your Home Assistant installation. Once installed, don't forget to restart your home assistant instance for the integration to be picked up.
How to setup
Please follow the setup guide to setup your initial account. This guide details the configuration, along with the sensors that will be available to you.
Docs
To get full use of the integration, please visit the docs.
FAQ
Before raising anything, please read through the faq. If you have questions, then you can raise a discussion. If you have found a bug or have a feature request please raise it using the appropriate report template.
Sponsorship
If you are enjoying the integration, why not use my referral link if you're not already a part of Octopus Energy, or if possible, make a one off or monthly GitHub sponsorship.