Sites
Energy cost data for all sites
Changed onRetrieves energy cost data across all sites
Scoped API keys require costs:read and effective site access.
API key: requires the costs:read scope.
get/v1/sites/cost
Request
- Base URLhttps://api.voltview.co.uk
- Auth
- API key in header x-api-key
- or HTTP bearer
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
Changes
- info
the endpoint scheme security
apiKeyAuthwas added to the API - info
the endpoint scheme security
sessionJwtwas added to the API
- info
- breaking
the
response's property type changed from no type toobjectfor status
6 more changes in this revision
- breaking