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
List all sites
Retrieves all sites associated with the authenticated user
GET
/
v1
/
sites
List all sites
Copy
curl --request GET \
--url https://api.voltview.co.uk/v1/sites \
--header 'Authorization: Bearer <token>'
Copy
[
{
"id": "<string>",
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"region": "<string>",
"floorArea": 123,
"buildingType": "<string>",
"meterCount": 123,
"utilities": [
"ELECTRICITY"
],
"status": "ACTIVE"
}
]
Authorizations
JWT token obtained from /v1/requestToken endpoint
Response
200
application/json
Sites retrieved successfully
The response is of type object[]
.
List all sites
Copy
curl --request GET \
--url https://api.voltview.co.uk/v1/sites \
--header 'Authorization: Bearer <token>'
Copy
[
{
"id": "<string>",
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"region": "<string>",
"floorArea": 123,
"buildingType": "<string>",
"meterCount": 123,
"utilities": [
"ELECTRICITY"
],
"status": "ACTIVE"
}
]
Assistant
Responses are generated using AI and may contain mistakes.