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
account_number = ""
api_key = ""
mpan = ""
serial_number = ""
energy_api = oe_api(account_number, api_key, mpan=mpan, serial_number=serial_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"
energy_api = oe_api(account_number, api_key)
To confirm this worked, the below can be used. A valid response should be returned.
energy_api.account_details()
Consumption
Getting all consumption data.
from octopus_energy_api import oe_api
import datetime
energy_api = oe_api(account_number, api_key, mpan=mpan, serial_number=serial_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)
Getting calculated consumption data - total, mean, and median.
from octopus_energy_api import oe_api
import datetime
energy_api = oe_api(account_number, api_key, mpan=mpan, serial_number=serial_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_total(start, today)
energy_api.consumption_mean(start, today)
energy_api.consumption_median(start, today)
Products
from octopus_energy_api import oe_api
energy_api = oe_api(account_number, api_key, mpan=mpan, serial_number=serial_number)
energy_api.products()
Meter Information
from octopus_energy_api import oe_api
energy_api = oe_api(account_number, api_key, mpan=mpan, serial_number=serial_number)
energy_api.meter_point()
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
octopus_energy_api-0.6.tar.gz
(4.2 kB
view hashes)
Built Distribution
Close
Hashes for octopus_energy_api-0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7093962c708f60990fa66e8dd73afe04f0e3c388245f76181610b1cbb1c9bd7 |
|
MD5 | e4b2d8099a406ab5510d27b3e132d5dd |
|
BLAKE2b-256 | ff76159cf3b3e8ebf8f8289c81fff16e3067f9c888c3d9de9887f3cd22288757 |