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
Tariffs for all sites
Retrieves energy tariff information across all sites
GET
/
v1
/
sites
/
tariffs
curl --request GET \
--url https://api.voltview.co.uk/v1/sites/tariffs \
--header 'Authorization: Bearer <token>'
[
{
"siteId": "<string>",
"supplier": "<string>",
"utility": "ELECTRICITY",
"tariffName": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"rates": [
{
"name": "<string>",
"rate": 123,
"startTime": "<string>",
"endTime": "<string>",
"daysOfWeek": [
"MONDAY"
]
}
]
}
]
Authorizations
JWT token obtained from /v1/requestToken endpoint
Response
200
application/json
Tariff information retrieved successfully
The response is of type object[]
.
curl --request GET \
--url https://api.voltview.co.uk/v1/sites/tariffs \
--header 'Authorization: Bearer <token>'
[
{
"siteId": "<string>",
"supplier": "<string>",
"utility": "ELECTRICITY",
"tariffName": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"rates": [
{
"name": "<string>",
"rate": 123,
"startTime": "<string>",
"endTime": "<string>",
"daysOfWeek": [
"MONDAY"
]
}
]
}
]
Assistant
Responses are generated using AI and may contain mistakes.