Account detail

Fetch properties, electricity and gas meter points, meters, registers, and tariff agreements for a customer account.

When to use this guide

You already have an account number (for example from a bill or your own records) and a dashboard API key. Discovering the account number without a bill is a v2 GraphQL viewer story; v1 REST requires you to supply A-XXXXXXXX.

Prerequisites

Dashboard API key - see authentication
Account number in the form A-12345678

Fetch account detail

using OctopusEnergy.Client;
using OctopusEnergy.Client.Models.Accounts;

const string apiKey = "sk_test_not_a_real_key";
CancellationToken cancellationToken = default;

using var client = new OctopusEnergyClient(apiKey);

Account account = await client.Accounts.GetAsync("A-12345678", cancellationToken);
Console.WriteLine($"{account.Number}: {account.Properties.Count} properties");

foreach (AccountProperty property in account.Properties)
{
    Console.WriteLine(property.AddressLine1);
    foreach (ElectricityMeterPoint mp in property.ElectricityMeterPoints)
    {
        Console.WriteLine($"  MPAN {mp.Mpan}: {mp.Agreements.Count} agreements");
    }
}

What the response contains

Each AccountProperty includes address fields, ElectricityMeterPoints, and GasMeterPoints. Meter points carry MPAN/MPRN, GSP, agreements (tariff codes and date ranges), and nested meters with registers.

Use tariff codes from agreements with tariff codes and GSP and tariff rates for standing charges and unit-rate history. Consumption intervals are on client.Consumption — see consumption.

Import vs export MPANs

The REST payload includes is_export on electricity meter points when the API returns it. When the field is missing, use TariffCode.Parse on agreement codes or other context. The API is not always obvious when you have multiple MPANs on one property.

if (point.IsExport == true)
{
    // Export MPAN - consumption endpoints still use the field name "consumption".
}

Errors

HTTP status	Exception	Typical cause
401	`OctopusEnergyApiException`	Missing or invalid API key
403	`OctopusEnergyApiException`	API access not enabled for the account user
404	`OctopusEnergyApiException`	Unknown account number

Empty or whitespace account numbers throw OctopusEnergyRequestException before any HTTP call.

See error handling.