Octopus Energy (prebuilt connector)

To view this content in our official product documentation, click here.

Description

Octopus Energy Group is a British renewable energy group specialising in sustainable energy. The Octopus Energy REST API enables customers and partners to interact with their platform - for example, to retrieve details about a UK gas or electricity meter-point.

API documentation

API documentation for Octopus Energy (used to build this connector) is available via your Octopia sandbox, via the link below:

{% embed url="https://sandbox-developer.cdscdn.com/apis#TNxxk" %}

Authentication

When adding connector instances for Octopus Energy, the following authentication methods are supported:

• API key

API key authentication

When a user chooses to add a connector instance using API key authentication, the credentials below are prompted:

Credential	Required?	Notes
api key	true	API keys are generated via the Octopus Energy dashboard.
MPAN	true	The electricity meter-point’s MPAN.
MPRN	true	The gas meter-point’s MPAN.
Gas meter serial number	true	The gas meter serial number.
Electric meter serial number	true	The gas meter serial number.