# Octopus Energy (prebuilt connector)

## 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](https://sandbox-developer.cdscdn.com/), via the link below:

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

## Authentication&#x20;

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

* [API key](#api-key-authentication)

### API key authentication

When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) using **API key** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="145" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>api key</code></td><td>true</td><td>API keys are generated via the Octopus Energy dashboard.</td></tr><tr><td><code>MPAN</code></td><td>true</td><td>The electricity meter-point’s MPAN.</td></tr><tr><td><code>MPRN</code></td><td>true</td><td>The gas meter-point’s MPAN.</td></tr><tr><td>Gas meter serial number</td><td>true</td><td>The gas meter serial number.</td></tr><tr><td>Electric meter serial number</td><td>true</td><td>The gas meter serial number.</td></tr></tbody></table>