OctopusEnergy.Client 1.0.3

dotnet add package OctopusEnergy.Client --version 1.0.3
                    
NuGet\Install-Package OctopusEnergy.Client -Version 1.0.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OctopusEnergy.Client" Version="1.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OctopusEnergy.Client" Version="1.0.3" />
                    
Directory.Packages.props
<PackageReference Include="OctopusEnergy.Client" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add OctopusEnergy.Client --version 1.0.3
                    
#r "nuget: OctopusEnergy.Client, 1.0.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package OctopusEnergy.Client@1.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=OctopusEnergy.Client&version=1.0.3
                    
Install as a Cake Addin
#tool nuget:?package=OctopusEnergy.Client&version=1.0.3
                    
Install as a Cake Tool

OctopusEnergy.Client

Unofficial .NET client for the Octopus Energy customer REST API (public catalogue plus authenticated account and consumption data). Not affiliated with Octopus Energy Limited.

Stable 1.0.x with SemVer guarantees for the REST customer core. GraphQL extras are planned for a later release; see SCOPE.md.

Dashboard API keys expose account structure and consumption. Treat keys as secrets and do not share them with untrusted third parties. This library is not a developer licence from Octopus Energy.

Install

dotnet add package OctopusEnergy.Client

Quick example

Public catalogue endpoints work without authentication:

using OctopusEnergy.Client;

using var client = new OctopusEnergyClient();

await foreach (var product in client.Products.ListAsync())
{
    Console.WriteLine(product.DisplayName);
}

For account and consumption calls, pass your API key from the Octopus dashboard.

Documentation

Full guides (authentication, products, tariffs, consumption, units, VAT, and time zones): markheydon.me.uk/octopus-energy-dotnet.

Source and issue tracker: github.com/markheydon/octopus-energy-dotnet

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net10.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.3 148 9/19/2026
1.0.2 105 9/18/2026
1.0.1 108 9/18/2026
1.0.0 103 9/18/2026