Specific Site

Energy cost data for a specific site

Changed on

Retrieves energy cost data for a specific site

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

API key: requires the costs:read scope.

get/v1/sites/{siteId}/cost

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

lookbackstring
Example:1y

Time period to look back (e.g. 1d, 1w, 1m, 1y for day, week, month, year)

granularity'hour' | 'day' | 'month' | 'year'

Data aggregation granularity

fromstring date-time
Example:2024-01-01T00:00:00.000Z

Start date and time (ISO 8601)

tostring date-time
Example:2024-12-31T23:59:59.999Z

End date and time (ISO 8601)

Response

Cost data retrieved successfully

siteIdstring

Site identifier

periodstring

Reporting period

totalCostnumber

Total cost in GBP

energyCostnumber

Energy cost in GBP

standingChargesnumber

Standing charges in GBP

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's body type changed from no type to object for status

    6 more changes in this revision