API Documentation
Authentication
Sites
- GETList all sites
- POSTAddress lookup
- GETPeak demand for all sites
- GETAnnual consumption and emissions for all sites
- GETAnnual spend and savings for all sites
- GETTariffs for all sites
- GETInvoices for all sites
- GETReports for all sites
- GETEnergy cost data for all sites
- GETEnergy intensity for all sites
- GETStatistics for all sites
- GETEnergy recommendations
Emissions
Specific Site
- GETAnnual consumption and emissions for a specific site
- GETAnnual spend and savings for a specific site
- GETPeak demand for a specific site
- GETTariffs for a specific site
- GETReports for a specific site
- GETStatistics for a specific site
- GETEnergy intensity for a specific site
- GETEnergy cost data for a specific site
Consumption
Supplier Integration
Bill Validation
Sites
Address lookup
Look up addresses by postcode
POST
/
v1
/
addressLookup
curl --request POST \
--url https://api.voltview.co.uk/v1/addressLookup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"postCode": "<string>",
"fuelType": "elec",
"customerConsent": "Yes"
}'
[
{
"id": "<string>",
"address": "<string>",
"postcode": "<string>",
"mpan": "<string>",
"mprn": "<string>"
}
]
Authorizations
JWT token obtained from /v1/requestToken endpoint
Body
application/json
Response
200
application/json
Address lookup successful
The response is of type object[]
.
curl --request POST \
--url https://api.voltview.co.uk/v1/addressLookup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"postCode": "<string>",
"fuelType": "elec",
"customerConsent": "Yes"
}'
[
{
"id": "<string>",
"address": "<string>",
"postcode": "<string>",
"mpan": "<string>",
"mprn": "<string>"
}
]
Assistant
Responses are generated using AI and may contain mistakes.