Python client for the Octopus Energy RESTful API
Project description
Octopus Energy Python API Client Library
A Client library for accessing the Octopus Energy APIs
Warning: The API is currently undergoing active development and should be considered unstable, even volatile until it reaches version 1.0.0
Installation
octopus-energy
can be installed from PyPI using pip:
pip install octopus-energy
Code
The code is available in the octopus-energy repository on GitHub
Features
- Get energy consumption from SMETS1 and SMETS2 electricity and gas meters.
Quickstart
You can obtain your API token and meter information from the Octopus Energy Developer Dashboard.
from octopus_energy import OctopusEnergyClient, MeterType
api_token="sk_live_your-token"
mprn = "your-mprn"
serial_number = "your-meter-serial-number"
client = OctopusEnergyClient(api_token)
consumption = await client.get_gas_consumption_v1(mprn, serial_number, MeterType.SMETS1_GAS)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
octopus-energy-0.1.2.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for octopus_energy-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 878e0477fd18cb9afd1d2873c844a7a4beeed21e60181f286262cfece7d2b770 |
|
MD5 | 7a8931f4ca366bae8da37e0aa9c43ed9 |
|
BLAKE2b-256 | 2eb208894e601aa10b689b33f93b5f6989077f2286fcabbd824456c2026a57bc |