Specific Site

Tariffs for a specific site

Changed on

Retrieves energy tariff information for a specific site

Scoped API keys require tariffs:read and effective site access.

API key: requires the tariffs:read scope.

get/v1/sites/{siteId}/tariffs

Request

  • Base URL
    https://api.voltview.co.uk
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

siteIdstring required

Site identifier

Query parameters

utility'ELECTRICITY' | 'GAS'

Filter tariffs by utility type

Response

Tariff information retrieved successfully

siteIdstring

Site identifier

supplierstring

Energy supplier name

utility'ELECTRICITY' | 'GAS'

Utility type

tariffNamestring

Tariff name

startDatestring date

Tariff start date

endDatestring date

Tariff end date

Changes

    • info

      the endpoint scheme security apiKeyAuth was added to the API

    • info

      the endpoint scheme security sessionJwt was added to the API

    • breaking

      the response property /// became optional for the status

    4 more changes in this revision