octopus-energy-api 0.3

Wrapper for communicating with the Octopus Energy API

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

Create an API instance. Access details 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, mpan, serial_number, account_number)

To confirm this worked, the below function can be used.

energy_api.account_details()

Getting Consumption Data

from octopus_energy_api import oe_api
import datetime

energy_api = oe_api(api_key, mpan, serial_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.get_consumption(start, today)