Octopus Energy plugin
This data source is contributed by a member of the community. Contact the data source author for any questions or issues.
Visualize your Octopus Energy consumption data and track their tariff prices.
Connecting to Octopus Energy requires the following information to be supplied when configuring the data source (all of which can be accessed at https://octopus.energy/dashboard/developer/)
- API Key
- Electricity Meter MPAN
- Electricity Meter Serial Number
- Gas Meter MPRN
- Gas Meter Serial Number
Configuring the data source
Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.- API Key:
Enter the API key you generated. This is used like a password to access your Octopus Energy account data. - Electricity Meter MPAN:
Enter the unique number for the electricity supply in your property. - Electricity Meter Serial Number:
Enter the serial number of your electricity meter. - Gas Meter MPRN:
Enter the unique number for the gas supply at a property. - Gas Meter Serial Number:
- Enter the serial number of your gas meter.
Restrict access to this data source:
Optionally, enable this toggle if you only want certain users/groups to have access to the data source, or those with the permission to link it to new workspaces. See data source access control for more information.Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect using the provided authentication method.
- Testing passed – a success message will be displayed and then the configuration will be saved.
- Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
- Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit data source configurations at any time from Settings > Data Sources.
Next steps
Data streams
You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.
Data streams are named queries targeted at a data source, typically mapped to a specific API endpoint. They define how SquaredUp retrieves live data. By standardizing information from diverse formats into a simple table, data streams provide a consistent starting point regardless of the original source system.
Each plugin includes its own set of data streams. When editing a tile or exploring data, the data stream you choose acts as the entry point to the objects and records within that data source.
Scoped data streams allow you to specify which objects to pull data about. Global data streams return general information not tied to objects.
Some data streams are configurable, meaning you can configure additional settings on the Parameters tab of the tile editor to create a bespoke query.
While creating a tile you can tweak data streams by grouping or aggregating specific columns.
See Data Streams for more information.
The following data streams are installed with this plugin.