Consumer Data Right (Energy) · OpenAPI Overlay 1.0.0

API Evangelist enhancements for CDR Common API

5 actions 5 updates update extends openapi/cdr-common-openapi.json

Derived by API Evangelist Built from the contracts Consumer Data Right (Energy) publishes. Consumer Data Right (Energy) did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-accessx-apievangelist-access-notex-apievangelist-slugx-apievangelist-artifactsx-apievangelist-security-profilex-apievangelist-security-profile-notex-apievangelist-error-registryx-apievangelist-base-url-resolution

Targets 3

$.info

$.paths['/discovery/status'].get

$.paths['/discovery/outages'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for CDR Common API
  version: 1.0.0
extends: openapi/cdr-common-openapi.json
x-generated: '2026-07-27'
x-method: generated
actions:
- target: $.info
  update:
    x-apievangelist-slug: cdr-energy
    x-apievangelist-artifacts:
      authentication: authentication/cdr-energy-authentication.yml
      scopes: scopes/cdr-energy-scopes.yml
      conventions: conventions/cdr-energy-conventions.yml
      errors: errors/cdr-energy-problem-types.yml
      lifecycle: lifecycle/cdr-energy-lifecycle.yml
      rate-limits: rate-limits/cdr-energy-rate-limits.yml
      conformance: conformance/cdr-energy-conformance.yml
      data-model: data-model/cdr-energy-data-model.yml
    x-apievangelist-security-profile: FAPI 1.0 Advanced; mutual TLS; private_key_jwt; PAR; PKCE S256
    x-apievangelist-security-profile-note: The Consumer Data Standards declare no components.securitySchemes
      in the OpenAPI documents; the security model is normative in a separate Security Profile section
      that all six APIs inherit.
    x-apievangelist-error-registry: urn:au-cds:error:* - ResponseErrorListV2 envelope, not RFC 9457
- target: $.info
  update:
    x-apievangelist-base-url-resolution:
      note: The servers[] entry in this document is a documentation placeholder (example.com). There is
        no single production base URL.
      discovery: https://api.cdr.gov.au/cdr-register/v1/energy/data-holders/brands/summary
      field: publicBaseUri
      path_suffix: /cds-au/v1
      registered_energy_brands: 84
      answered_anonymously_2026_07_27: 53
- target: $.info
  update:
    x-apievangelist-unauthenticated-operations:
    - getStatus
    - getOutages
- target: $.paths['/discovery/status'].get
  update:
    x-apievangelist-access: open
    x-apievangelist-access-note: No credential required. Verified with a live anonymous request on 2026-07-27.
- target: $.paths['/discovery/outages'].get
  update:
    x-apievangelist-access: open
    x-apievangelist-access-note: No credential required. Verified with a live anonymous request on 2026-07-27.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/cdr-energy-common-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.