GET
/
v1
/
sites
/
{siteId}
/
tariffs
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/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

​
Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Path Parameters

​
siteId
string
required

Site identifier

Query Parameters

​
utility
enum<string>

Filter tariffs by utility type

Available options:
ELECTRICITY,
GAS

Response

200
application/json
Tariff information retrieved successfully
​
siteId
string
required

Site identifier

​
supplier
string
required

Energy supplier name

​
utility
enum<string>
required

Utility type

Available options:
ELECTRICITY,
GAS
​
tariffName
string

Tariff name

​
startDate
string

Tariff start date

​
endDate
string

Tariff end date

​
rates
object[]

Tariff rates