How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Consumer Data Right (Energy) Electricity Usage API

Electricity Usage endpoints

Consumer Data Right (Energy) Electricity Usage API is one of 17 APIs that Consumer Data Right (Energy) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Electricity Usage. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a GitHub repository.

This API exposes 3 operations across 2 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.36.0.

Requests are made against a single base URL, https://mtls.dh.example.com/cds-au/v1.

3 operations 2 paths 17 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.36.0
Base URL
https://api.cdr.gov.au/cdr-register/v1
Resource Areas
1

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Electricity Usage 3

Electricity Usage endpoints

GET
/energy/electricity/servicepoints/{servicePointId}/usage
Get Usage For Service Point
getElectricityServicePointUsage 12 params → 200400404406422
GET
/energy/electricity/servicepoints/usage
Get Bulk Usage
listElectricityUsageBulk 11 params → 200400406422
POST
/energy/electricity/servicepoints/usage
Get Usage For Specific Service Points
listElectricityUsageForServicePoints 11 params body → 200400406422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are EnergyUsageRead (11 properties), LinksPaginated (5 properties), ErrorV2 (4 properties), EnergyUsageRead_intervalRead (4 properties). Each schema is shown below with its type and property counts.

ErrorV2_meta
object
Additional data for customised error codes.
1 property
EnergyUsageListResponse_data
object
1 property 1 required
MetaPaginated
object
2 properties 2 required
Meta
object
LinksPaginated
object
5 properties 1 required
ErrorV2
object
4 properties 3 required
EnergyServicePointId
string
A unique identifier for an Energy service point, generated according to [CDR ID Permanence](id-permanence) requirements.
RequestServicePointIdListV1_data
object
1 property 1 required
PrimaryErrorV1
object
PrimaryErrorV1_allOf
object
1 property
EnergyUsageRead_basicRead
object
Mandatory if readUType is set to basicRead.
2 properties 1 required
EnergyUsageRead_intervalRead
object
Mandatory if readUType is set to intervalRead.
4 properties 1 required
RequestServicePointIdListV1
object
2 properties 1 required
EnergyUsageRead_intervalRead_readQualities
object
3 properties 3 required
EnergyUsageRead
object
11 properties 4 required
EnergyUsageListResponse
object
3 properties 3 required
PrimaryResponseErrorListV1
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cdr-energy-electricity-usage-api-openapi.yml Raw ↑

Other APIs Consumer Data Right (Energy) publishes across the network.

Consumer Data Right (Energy) Data Holder Admin API
Consumer Data Right (Energy) Data Holder Client Registration API
Consumer Data Right (Energy) Data Holder Customers API
Consumer Data Right (Energy) Data Holder Operations API
Consumer Data Right (Energy) Distributed Energy Resources API
Consumer Data Right (Energy) Distributed Energy Resources (SR) API
Consumer Data Right (Energy) Electricity Service Points API
Consumer Data Right (Energy) Electricity Service Points (SR) API
Consumer Data Right (Energy) Electricity Usage (SR) API
Consumer Data Right (Energy) Energy Account Balances API
Consumer Data Right (Energy) Energy Account Billing API
Consumer Data Right (Energy) Energy Accounts API
Where this information came from

This is an independent, third-party profile of Consumer Data Right (Energy) Electricity Usage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.