Download OpenAPI specification:Download
Consumer Data Right end points and payloads for the Energy sector
Obtain a list of energy plans that are currently offered to the market
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) |
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. |
{- "data": {
- "plans": [
- {
- "planId": "string",
- "effectiveFrom": "string",
- "effectiveTo": "string",
- "lastUpdated": "string",
- "displayName": "string",
- "description": "string",
- "type": "STANDING",
- "fuelType": "ELECTRICITY",
- "availability": "GENERAL",
- "brand": "string",
- "brandName": "string",
- "thirdPartyAgentId": "string",
- "thirdPartyAgentName": "string",
- "applicationUri": "string",
- "additionalInformation": {
- "overviewUri": "string",
- "termsUri": "string",
- "eligibilityUri": "string",
- "pricingUri": "string",
- "bundleUri": "string"
}, - "customerType": "RESIDENTIAL",
- "geography": {
- "excludedPostcodes": [
- "string"
], - "includedPostcodes": [
- "string"
], - "supplyAreas": [
- {
- "supplyAreaId": "string",
- "displayName": "string",
- "distributor": "string",
- "state": "string"
}
]
}
}
]
}, - "links": {
- "self": "string",
- "first": "string",
- "prev": "string",
- "next": "string",
- "last": "string"
}, - "meta": {
- "totalRecords": 0,
- "totalPages": 0
}
}
Obtain detailed information on a single energy plan offered openly to the market
planId required | string ID of the specific plan requested |
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. |
{- "data": {
- "planId": "string",
- "effectiveFrom": "string",
- "effectiveTo": "string",
- "lastUpdated": "string",
- "displayName": "string",
- "description": "string",
- "type": "STANDING",
- "fuelType": "ELECTRICITY",
- "availability": "RESTRICTED",
- "brand": "string",
- "brandName": "string",
- "thirdPartyAgentId": "string",
- "thirdPartyAgentName": "string",
- "applicationUri": "string",
- "additionalInformation": {
- "overviewUri": "string",
- "termsUri": "string",
- "eligibilityUri": "string",
- "pricingUri": "string",
- "bundleUri": "string"
}, - "customerType": "RESIDENTIAL",
- "geography": {
- "excludedPostcodes": [
- "string"
], - "includedPostcodes": [
- "string"
], - "supplyAreas": [
- {
- "supplyAreaId": "string",
- "displayName": "string",
- "distributor": "string",
- "state": "string"
}
]
}, - "meteringCharges": [
- {
- "displayName": "string",
- "description": "string",
- "minimumValue": "string",
- "maximumValue": "string",
- "period": "string"
}
], - "gasContract": {
- "additionalFeeInformation": "string",
- "pricingModel": "SINGLE_RATE",
- "termType": "1_YEAR",
- "timeZone": "LOCAL",
- "benefitPeriod": "string",
- "terms": "string",
- "isFixed": true,
- "variation": "string",
- "onExpiryDescription": "string",
- "meterTypes": [
- "string"
], - "coolingOffDays": "string",
- "billFrequency": [
- "string"
], - "controlledLoad": {
- "displayName": "string",
- "description": "string",
- "dailyCharge": "string",
- "period": "string",
- "rates": [
- {
- "unitPrice": "string",
- "volume": 0
}
]
}, - "paymentOption": [
- "PAPER_BILL"
], - "incentives": [
- {
- "displayName": "string",
- "description": "string"
}
], - "discounts": [
- {
- "displayName": "string",
- "description": "string",
- "type": "CONDITIONAL",
- "category": "PAY_ON_TIME",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": "string"
}, - "percentOfUse": {
- "rate": "string"
}, - "fixedAmount": {
- "amount": "string"
}, - "percentOverThreshold": {
- "rate": "string",
- "usageAmount": "string"
}
}
], - "greenPowerCharges": [
- {
- "displayName": "string",
- "description": "string",
- "type": "FIXED_PER_DAY",
- "tiers": [
- {
- "percentGreen": "string",
- "rate": "string",
- "amount": "string"
}
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "string",
- "description": "string"
}
], - "fee": [
- {
- "type": "EXIT",
- "term": "FIXED",
- "amount": "string",
- "rate": "string",
- "description": "string"
}
], - "solarFeedInTariff": [
- {
- "type": "GOVERNMENT",
- "amount": "string",
- "description": "string"
}
], - "tariffPeriod": [
- {
- "displayName": "string",
- "startDate": "string",
- "endDate": "string",
- "dailySupplyCharges": "string",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": "string",
- "description": "string",
- "generalUnitPrice": "string",
- "period": "string",
- "rates": [
- {
- "unitPrice": "string",
- "volume": 0
}
]
}, - "timeOfUseRates": [
- {
- "displayName": "string",
- "description": "string",
- "type": "PEAK",
- "rates": [
- {
- "unitPrice": "string",
- "volume": 0
}
], - "timeOfUse": [
- {
- "days": [
- null
], - "startTime": "string",
- "endTime": "string"
}
], - "demandCharges": [
- {
- "displayName": "string",
- "description": "string",
- "amount": "string",
- "startTime": "string",
- "endTime": "string"
}
]
}
]
}
]
}, - "electricityContract": {
- "additionalFeeInformation": "string",
- "pricingModel": "SINGLE_RATE",
- "termType": "1_YEAR",
- "timeZone": "LOCAL",