Australian Consumer Data Standards

CDR Energy API

Specifications for resource endpoints applicable to data holders in the Energy sector.

Government & public#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Specifications for resource endpoints applicable to data holders in the Energy sector.

Endpoints 23

Energy Plans

  • GETGet Generic Planshttps://tls.dh.example.com/cds-au/v1/energy/plansObtain a list of energy plans that are currently offered to the market. Note that the results returned by this endpoint are expected to be ordered in…
  • GETGet Generic Plan Detailhttps://tls.dh.example.com/cds-au/v1/energy/plans/:planIdObtain detailed information on a single energy plan offered openly to the market. Other Versions: v1, v2.

Electricity Service Points

  • GETGet Service Points/energy/electricity/servicepointsObtain a list of service points owned by the customer that has authorised the current session. Other Versions: v1.
  • GETGet Service Point Detail/energy/electricity/servicepoints/:servicePointIdObtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session. Other Versions: v1.

Electricity Usage

  • GETGet Usage For Service Point/energy/electricity/servicepoints/:servicePointId/usageObtain a list of electricity usage data from a particular service point.
  • GETGet Bulk Usage/energy/electricity/servicepoints/usageObtain usage data for all service points associated with the customer.
  • POSTGet Usage For Specific Service Points/energy/electricity/servicepoints/usageObtain the electricity usage data for a specific set of service points.

Distributed Energy Resources

  • GETGet DER For Service Point/energy/electricity/servicepoints/:servicePointId/derObtain a list of DER data from a particular service point.
  • GETGet Bulk DER/energy/electricity/servicepoints/derObtain DER data for all service points associated with the customer.
  • POSTGet DER For Specific Service Points/energy/electricity/servicepoints/derObtain DER data for a specific set of service points.

Energy Accounts

  • GETGet Energy Accounts/energy/accountsObtain the list of energy accounts available under the authorised consent. Other Versions: v1.
  • GETGet Energy Account Detail/energy/accounts/:accountIdObtain detailed information for a specific energy account. Other Versions: v1, v2, v3.
  • GETGet Agreed Payment Schedule/energy/accounts/:accountId/payment-scheduleObtain the agreed payment schedule and details, if any, for a specific energy account. Some general notes about this endpoint: <ul><li>This API describes how…
  • GETGet Concessions/energy/accounts/:accountId/concessionsObtain the details of any concessions or arrangements applied to a specific energy account.

Energy Account Balances

  • GETGet Balance For Energy Account/energy/accounts/:accountId/balanceObtain the current balance for a specific account.
  • GETGet Bulk Balances for Energy/energy/accounts/balancesObtain the current balance for all accounts.
  • POSTGet Balances For Specific Energy Accounts/energy/accounts/balancesObtain the current balance for a specified set of accounts.

Energy Account Billing

  • GETGet Invoices For Account/energy/accounts/:accountId/invoicesObtain the invoices for a specific account.
  • GETGet Bulk Invoices/energy/accounts/invoicesObtain the invoices for all accounts.
  • POSTGet Invoices For Specific Accounts/energy/accounts/invoicesObtain invoices for a specified set of accounts.
  • GETGet Billing For Account/energy/accounts/:accountId/billingObtain the billing transactions for a specific account. Deprecated Versions: v1 - This version is to be ceased to be called by data recipients by September…
  • GETGet Bulk Billing/energy/accounts/billingObtain billing transactions for all accounts. Deprecated Versions: v1 - This version is to be ceased to be called by data recipients by September 9th 2024 and…
  • POSTGet Billing For Specific Accounts/energy/accounts/billingObtain billing for a specified set of accounts. Deprecated Versions: v1 - This version is to be ceased to be called by data recipients by September 9th 2024…

API details

Base URL
https://mtls.dh.example.com/cds-au/v1
Authentication
None declared in the description
Operations
23 operations on 18 pathsGET 18POST 5
Main resources
Energy Account Billing 6Energy Accounts 4Distributed Energy Resources 3Electricity Usage 3Energy Account Balances 3Electricity Service Points 2Energy Plans 2
Description format
OpenAPI 3.0.3, API version 1.36.0

How to test the CDR Energy API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CDR Energy API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get Generic Plans” (GET https://tls.dh.example.com/cds-au/v1/energy/plans), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CDR Energy API?

Specifications for resource endpoints applicable to data holders in the Energy sector. It is listed under Government & public and has 23 endpoints.

Who publishes the CDR Energy API?

It is listed from Australian Consumer Data Standards's public API description (an OpenAPI document), not published by Australian Consumer Data Standards on Swastik Codes. Anyone who controls consumerdatastandards.gov.au can claim the profile by adding a DNS TXT record.

What is the base URL of the CDR Energy API?

Requests go to https://mtls.dh.example.com/cds-au/v1. Endpoint paths are added to this base URL.

How do I authenticate with the CDR Energy API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the CDR Energy API have?

23 operations on 18 paths (18 GET, 5 POST). The largest groups are Energy Account Billing, Energy Accounts, Distributed Energy Resources, Electricity Usage.

Is forking the CDR Energy API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.