Product data refers to information on all the products that are provided by a data holder and does not include any consumer data. For example, in the banking sector product data includes information such as interest rates, fees and changes as well as eligibility criteria.
Data holders will have an API that can be used to request their product data in a machine-readable format. API stands for application programming interface, which is a set of definitions and protocols for building and integrating application software. For more information on how APIs are used in the Consumer Data Right see how it works.
Public APIs expose no consumer data, so they are unauthenticated. All public APIs are expected to be accessible via the public base URI which is defined in the Consumer Data Standards. This means they all have a common base address which is the public base URI.
This page outlines how to find a data holder’s product data API by first retrieving the public base URI from the Register Get Data Holder Brands Summary API. It is important to note that to be able to call the below APIs you will need software that allows you to call APIs, such as Postman or Insomnia. Calling or pasting the API URLs into your browser will return an error.
The step-by-step process
1. Get a data holder's public details from the register
Using your preferred API software, send a request to the Register’s Get Data Holder Brands Summary API. This API provides information about all data holders. This endpoint is publicly available and enables the discovery of public details of data holder brands. The below API will return the public details of all data holders.
Note: Please ensure your API call adheres to the Consumer Data Standards, including the mandatory x-v header.
For each data holder in the API response, a public base URI will be included which can be used to call a data holder’s public endpoints such as those that expose product data. For the energy sector, active data holder’s public base URI will not be able to be used to call their product data APIs. To locate the correct energy base URI please refer to the AER's website.
2. Get a data holder's product data
All data holder product data APIs are documented within the Consumer Data Standards. For more information about the banking product data APIs refer to:
For more information about the energy product data APIs see: