Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.voltview.co.uk/llms.txt

Use this file to discover all available pages before exploring further.

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

Bill Validation API

Validate and audit utility bills for accuracy

Getting Started

Register for a VoltView account to receive your API credentials here.

Authentication

The VoltView API uses a VoltView API key for authentication. Include your API key directly on every request:
{
  "x-api-key": "your-api-key"
}

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:
MetricUnit
Energy ConsumptionkWh
Power DemandkW
Carbon Emissionskg CO2eq
CurrencyGBP (£)
Time SeriesISO 8601 format
Numeric ValuesRounded to 2 decimal places
Meter Point NumbersMPAN/MPRN format
Supplier Read FrequencyMinutes/Hours/Days
Reading TypeActual/Estimated