get_electricity_consumption
Retrieve electricity consumption data from Octopus Energy accounts with date range filtering, pagination, and grouping options to analyze energy usage patterns.
Instructions
Get electricity consumption data from Octopus Energy. Returns consumption in kWh with 0.045 kWh precision. MPAN and serial number can be provided as parameters or will use values from ELECTRICITY_MPAN and ELECTRICITY_SERIAL_NUMBER environment variables.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mpan | No | The MPAN (Meter Point Administration Number) for the electricity meter. Optional if ELECTRICITY_MPAN is set in .env | |
| serial_number | No | The meter serial number. Optional if ELECTRICITY_SERIAL_NUMBER is set in .env | |
| period_from | No | Start date/time in ISO 8601 format with UTC indicator (e.g., 2024-01-01T00:00:00Z) | |
| period_to | No | End date/time in ISO 8601 format with UTC indicator (e.g., 2024-01-31T23:59:59Z) | |
| page_size | No | Number of results per page (default: 100, max: 25000) | |
| order_by | No | Set to 'period' to return earliest records first (default: latest first) | |
| group_by | No | Group results by: day, week, month, or quarter |