CDR Energy Standards - DRAFT (0.2.0)

Download OpenAPI specification:Download

Consumer Data Right end points and payloads for the Energy sector

Generic Tariffs

Get Generic Plans

Obtain a list of energy plans that are currently offered to the market

query Parameters
type
string
Default: "ALL"
Enum: "STANDING" "MARKET" "REGULATED" "ALL"

Used to filter results on the type field. Any one of the valid values for this field can be supplied plus 'ALL'. If absent defaults to 'ALL'

fuelType
string
Default: "ALL"
Enum: "ELECTRICITY" "GAS" "DUAL" "ALL"

Used to filter results on the fuelType field. Any one of the valid values for this field can be supplied plus 'ALL'. If absent defaults to 'ALL'

effective
string
Default: "CURRENT"
Enum: "CURRENT" "FUTURE" "ALL"

Allows for the filtering of plans based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'

updated-since
string

Only include plans that have been updated after the specified date and time. If absent defaults to include all plans

brand
string

Used to filter results on the brand field. If absent defaults to include all plans

page
number
Default: "1"

Page of results to request (standard pagination)

page-size
number
Default: "25"

Page size to request. Default is 25 (standard pagination)

header Parameters
x-v
required
string

Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Get Generic Plan Detail

Obtain detailed information on a single energy plan offered openly to the market

path Parameters
planId
required
string

ID of the specific plan requested

header Parameters
x-v
required
string

Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "data": {