get_gas_consumption
Retrieve gas consumption data from Octopus Energy accounts for specified date ranges, with options to group by time periods and customize result formats.
Instructions
Get gas consumption data from Octopus Energy. Returns consumption in kWh for SMETS1 meters or cubic meters for SMETS2 meters. MPRN and serial number can be provided as parameters or will use values from GAS_MPRN and GAS_SERIAL_NUMBER environment variables.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mprn | No | The MPRN (Meter Point Reference Number) for the gas meter. Optional if GAS_MPRN is set in .env | |
| serial_number | No | The meter serial number. Optional if GAS_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 |