Home Assistant Octopus Energy
Bring your Octopus Energy details into Home Assistant to help you towards a more energy efficient (and or cheaper) home.
https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy
Category: Energy Systems
Sub Category: Building Energy Monitoring
Keywords
energy-consumption home-assistant home-automation octopus-energy smart-home
Keywords from Contributors
solar hacs octopus varta varta-storage
Last synced: about 22 hours ago
JSON representation
Repository metadata
Unofficial Home Assistant integration for interacting with Octopus Energy
- Host: GitHub
- URL: https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy
- Owner: BottlecapDave
- License: mit
- Created: 2021-08-30T09:13:05.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-11-07T07:26:40.000Z (2 months ago)
- Last Synced: 2026-01-02T08:46:36.034Z (9 days ago)
- Topics: energy-consumption, home-assistant, home-automation, octopus-energy, smart-home
- Language: Python
- Homepage: https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/
- Size: 7.06 MB
- Stars: 845
- Watchers: 24
- Forks: 87
- Open Issues: 48
- Releases: 207
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
README.md
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
- Electricity and gas meter support including consumption data and rate information
- Custom sensor support to target cheapest rates
- Custom sensor support for tracking costs of other entities
- Custom sensor support for comparing to other tariffs
- Octopus Home mini support
- Intelligent tariff settings support
- Saving sessions support
- Wheel of fortune support
- Greener days support
- Heat Pump support
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:
- Add the repository to your HACS installation
- Click
Download
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 <config directory>/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.
Owner metadata
- Name: David Kendall
- Login: BottlecapDave
- Email:
- Kind: user
- Description:
- Website: http://www.davidskendall.co.uk
- Location:
- Twitter: BottlecapDave
- Company:
- Icon url: https://avatars.githubusercontent.com/u/14993950?u=bb1dd529ecadeb7db9fa57be0203bc94f7dd2c57&v=4
- Repositories: 9
- Last ynced at: 2025-10-26T01:54:47.131Z
- Profile URL: https://github.com/BottlecapDave
GitHub Events
Total
- Fork event: 22
- Discussion event: 6
- Create event: 76
- Commit comment event: 9
- Issues event: 459
- Release event: 47
- Watch event: 187
- Delete event: 30
- Issue comment event: 1799
- Push event: 436
- Pull request review event: 43
- Pull request review comment event: 65
- Pull request event: 166
Last Year
- Fork event: 20
- Discussion event: 9
- Create event: 66
- Commit comment event: 7
- Release event: 37
- Issues event: 418
- Watch event: 158
- Delete event: 28
- Issue comment event: 1671
- Push event: 376
- Pull request review event: 43
- Pull request review comment event: 65
- Pull request event: 148
Committers metadata
Last synced: 14 days ago
Total Commits: 1,395
Total Committers: 31
Avg Commits per committer: 45.0
Development Distribution Score (DDS): 0.164
Commits in past year: 273
Committers in past year: 12
Avg Commits per committer in past year: 22.75
Development Distribution Score (DDS) in past year: 0.22
| Name | Commits | |
|---|---|---|
| BottlecapDave | me@d****k | 1166 |
| semantic-release-bot | s****t@m****t | 163 |
| Sam Reed | s****m@r****t | 19 |
| Geoffrey Coan | 1****n | 13 |
| Thomas Grocutt | t****m@d****k | 4 |
| Dave Wood | d****d@g****m | 2 |
| David Kendall | d****d@r****m | 2 |
| Lewis Juggins | 8****s | 2 |
| Mark Cocker | m****r@u****m | 2 |
| Alec Rust | me@a****m | 1 |
| Andrew Aylett | a****w@a****k | 1 |
| Andrew Jackson | a****w@c****g | 1 |
| Ben Campbell | M****1 | 1 |
| Colin Seymour | c****n@s****o | 1 |
| DJBenson | d****n@g****m | 1 |
| Gavin Melling | g****n@p****m | 1 |
| Grant Bevis | 2****s | 1 |
| Ian Gibbs | i****s@c****g | 1 |
| Jack | 4****y | 1 |
| Jay Turner | j****r@g****m | 1 |
| John Cuthbert | 1****k | 1 |
| Matt | 6****d | 1 |
| Michael | t****r@g****m | 1 |
| MrListerCoUk | 6****k | 1 |
| Speak to the Geek | 4****r | 1 |
| Stuart Chapman | S****z | 1 |
| Tom Carpenter | s****h@h****m | 1 |
| UK-JustinSmall | 1****l | 1 |
| justwatchme | 5****e | 1 |
| ksimuk | m****v@g****m | 1 |
| and 1 more... | ||
Committer domains:
- cpan.org: 1
- pixelinspiration.com: 1
- symr.io: 1
- codechimp.org: 1
- aylett.co.uk: 1
- alecrust.com: 1
- uk.ibm.com: 1
- rocketmakers.com: 1
- dsoworld.co.uk: 1
- reedyboy.net: 1
- martynus.net: 1
- davidskendall.co.uk: 1
Issue and Pull Request metadata
Last synced: 7 days ago
Total issues: 777
Total pull requests: 362
Average time to close issues: 25 days
Average time to close pull requests: 7 days
Total issue authors: 507
Total pull request authors: 40
Average comments per issue: 5.33
Average comments per pull request: 0.5
Merged pull request: 302
Bot issues: 0
Bot pull requests: 0
Past year issues: 223
Past year pull requests: 95
Past year average time to close issues: 15 days
Past year average time to close pull requests: 6 days
Past year issue authors: 176
Past year pull request authors: 13
Past year average comments per issue: 4.17
Past year average comments per pull request: 0.36
Past year merged pull request: 65
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- BottlecapDave (49)
- reedy (18)
- djdarlo (12)
- gcoan (10)
- pacemaker82 (9)
- alfwro13 (8)
- sshaikh (7)
- UK-JustinSmall (6)
- mdeakin99 (6)
- springfall2008 (6)
- holdestmade (6)
- jwt99412 (5)
- plord12 (5)
- JRascagneres (5)
- Quickstep3 (5)
Top Pull Request Authors
- BottlecapDave (275)
- reedy (26)
- lwis (6)
- gcoan (6)
- 696GrocuttT (3)
- mitchellrj (2)
- TurnrDev (2)
- jeverley (2)
- thecem (2)
- thewishy (2)
- andrewaylett (2)
- sargant (2)
- sOckhamSter (2)
- Pixel-Gavin (2)
- grantbevis (2)
Top Issue Labels
- bug (552)
- enhancement (185)
- stale (68)
- next release (35)
- awaiting-maintainer-response (24)
- awaiting release confirmation (14)
- More demand needed (11)
- Octopus Energy issue (9)
- Available in beta (8)
- breaking change (7)
- external contributions welcome (6)
- help wanted (5)
- Octopus Energy API change (4)
- awaiting response (2)
- next-release (2)
- question (2)
- under consideration (1)
Top Pull Request Labels
- released (69)
- enhancement (1)
- bug (1)
- breaking change (1)
- awaiting-maintainer-response (1)
Package metadata
- Total packages: 2
- Total downloads: unknown
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 378
proxy.golang.org: github.com/BottlecapDave/HomeAssistant-OctopusEnergy
- Homepage:
- Documentation: https://pkg.go.dev/github.com/BottlecapDave/HomeAssistant-OctopusEnergy#section-documentation
- Licenses: mit
- Latest release: v17.1.1+incompatible (published 2 months ago)
- Last Synced: 2026-01-08T11:31:28.914Z (3 days ago)
- Versions: 189
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.401%
- Average: 5.583%
- Dependent repos count: 5.764%
proxy.golang.org: github.com/bottlecapdave/homeassistant-octopusenergy
- Homepage:
- Documentation: https://pkg.go.dev/github.com/bottlecapdave/homeassistant-octopusenergy#section-documentation
- Licenses: mit
- Latest release: v17.1.1+incompatible (published 2 months ago)
- Last Synced: 2026-01-08T11:31:29.207Z (3 days ago)
- Versions: 189
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.401%
- Average: 5.583%
- Dependent repos count: 5.764%
Dependencies
- 657 dependencies
- @semantic-release/changelog ^6.0.1 development
- @semantic-release/exec ^6.0.2 development
- @semantic-release/git ^10.0.1 development
- commitizen ^4.2.4 development
- conventional-changelog-eslint ^3.0.9 development
- cz-customizable ^6.3.0 development
- husky ^4.3.8 development
- semantic-release ^18.0.0 development
- homeassistant >=2021.12.01
- mock *
- pytest *
- pytest-asyncio *
- pytest-socket *
- actions/stale v4 composite
- actions/checkout v2 composite
- asdf-vm/actions/install v1 composite
- devmasx/merge-branch master composite
- hacs/action main composite
- home-assistant/actions/hassfest master composite
- mike ==2.0.0
- mkdocs-material ==9.5.1
- actions/cache v3 composite
- actions/checkout v4 composite
- actions/setup-python v4 composite
Score: -Infinity