# Octopus Energy API

Source: https://docs.evcc.io/en/tariffs/octopus-energy-api

You can get the API key in the Octopus portal: [octopus.energy](https://octopus.energy/dashboard/new/accounts/personal-details/api-access)

Supported features: United Kingdom

## Parameters

| Name | Description | Default / example | |
| --- | --- | --- | --- |
| apiKey | API Key |  |  |
| accountNumber | Account Number Only required if you have multiple accounts. | X-XXXXXXXX |  |
| tariffDirection | The tariff flow direction to query from Octopus. Set to 'export' when using feedin: (import, export) | import |  |

## Configuration example for evcc.yaml

```yaml
tariffs:
    grid:
      type: template
      template: octopus-api
      apiKey: # API Key
      accountNumber: X-XXXXXXXX # Account Number, Only required if you have multiple accounts. (optional)
      tariffDirection: import # The tariff flow direction to query from Octopus., Set to 'export' when using feedin: [import, export] (optional)
```