OctopusEnergy.Client

Unofficial .NET SDK for the Octopus Energy customer APIs

View the Project on GitHub markheydon/octopus-energy-dotnet

OctopusEnergy.Client documentation

Unofficial .NET SDK for the Octopus Energy customer APIs. These pages help you install the package, authenticate with a dashboard API key, and call products, tariffs, rates, account, and consumption endpoints.

New here? Start with Getting started.

Guides

Topic What it covers
Getting started Install the package, construct the client, first API calls
Authentication API keys and HTTP Basic
Pagination Listing resources without managing next links
Products catalogue List products and load product detail
Account detail Fetch properties, meters, and agreements
Consumption Electricity and gas smart-meter intervals
Tariff rates Standing charges and unit-rate history
Industry lookups GSP by postcode and MPAN lookup
Tariff codes and GSP Parse tariff codes and build charge paths
Error handling API failures and exception types

Reference and concepts

Topic What it covers
API coverage What the SDK implements today
Units, VAT, and time kWh, pence, VAT fields, BST, Agile 16:00
Customer vs partner Why the public surface is small
REST and GraphQL Dual transport (v1 is REST)