Wrapper for communicating with the Octopus Energy API
Project description
GitHub: github.com/euanacampbell/octopus_energy_api
PyPi: pypi.org/project/octopus-energy-api
Installation
pip install octopus-energy-api
Import
from octopus_energy_api import oe_api
Usage
Two ways of creating an API instance.
Load access details in manually - Can be found using this fantastic tutorial by Guy Lipman guylipman.medium.com.
from octopus_energy_api import oe_api
api_key = ""
mpan = ""
serial_number = ""
account_number = ""
energy_api = oe_api(api_key=api_key, mpan=mpan, serial_number=serial_number, account_number=account_number)
Get mpan and serial numbers from account number + api key. (currently only works for single property accounts)
from octopus_energy_api import oe_api
api_key = "value here"
account_number = "value here"
account_details = oe_api.get_mpan_serial(account_number, api_key)
energy_api = oe_api(api_key=api_key, mpan=account_details['mpan'], serial_number=account_details['serial_numbers'][1], account_number=account_number)
To confirm this worked, the below can be used. A valid response should be returned.
energy_api.account_details()
Consumption Data
from octopus_energy_api import oe_api
import datetime
energy_api = oe_api(api_key=api_key, mpan=mpan, serial_number=serial_number, account_number=account_number)
today = datetime.date.today() # setting end date to today
start = today.replace(day=1) # setting start date to the beginning of the month
energy_api.consumption(start, today)
Product Data
from octopus_energy_api import oe_api
energy_api = oe_api(api_key=api_key, mpan=mpan, serial_number=serial_number, account_number=account_number)
energy_api.products()
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for octopus_energy_api-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc63d54f7b0c9bd230e9b8ff3b85e7bafa6185cc2bf1966b9e53a6efb5222bdb |
|
MD5 | 33ee5b658154189dfde46b670087b7f7 |
|
BLAKE2b-256 | 3a39cadb6514d71797944322631bbe4055793686ac16ad673fbd5ac31d5adf8b |