Introduction
VoltView API Documentation - Energy Monitoring and Management
Welcome to VoltView API
The VoltView API provides comprehensive energy monitoring and management capabilities for multi-site businesses, enabling real-time tracking of energy consumption, cost analysis, and environmental impact metrics.
API Suite Overview
Our API suite includes the following core services:
Site Management API
Manage and monitor multiple site locations
Energy Consumption API
Access detailed energy usage data
Cost Analysis API
Track and analyse energy costs
Environmental Metrics API
Monitor carbon emissions and energy efficiency
Utility Supplier API
Integrate and collect data from utility suppliers
Getting Started
To start using the VoltView API, follow these steps:
- Sign up for a VoltView account to receive your API credentials
- Review our data granularity options (hourly/daily/monthly)
- Ensure your requests are sent via HTTPS
All API responses are returned in JSON format.
Authentication
The VoltView API uses JWT (JSON Web Token) authentication to secure all endpoints.
Token Management
- Generate a JWT token using your API credentials
- Include the token in the Authorization header
- Tokens expire after 24 hours
- Invalid tokens return a 401 Unauthorized response
Authentication Error Response
If authentication fails, you will receive an HTTP 401 Unauthorized response with a detailed error message in the JSON response body.
Data Units
The VoltView API uses the following standardized units across all endpoints:
| Metric | Unit |
|---|---|
| Energy Consumption | kWh |
| Power Demand | kW |
| Carbon Emissions | kg CO2eq |
| Currency | GBP (£) |
| Time Series | ISO 8601 format |
| Numeric Values | Rounded to 2 decimal places |
| Meter Point Numbers | MPAN/MPRN format |
| Supplier Read Frequency | Minutes/Hours/Days |
| Reading Type | Actual/Estimated |