# VoltView

- [Overview](https://docs.voltview.co.uk/introduction.md): Start Managing All Your Energy in One Place
- [Register](https://docs.voltview.co.uk/register.md)
- [Introduction](https://docs.voltview.co.uk/api-reference/introduction.md): VoltView API Documentation - Energy Monitoring and Management
- [Fetch user profile](https://docs.voltview.co.uk/api-reference/user/fetch-user-profile.md): Retrieves the authenticated user's profile information
- [List all users](https://docs.voltview.co.uk/api-reference/user/list-all-users.md): List all users in the organization. Requires admin permissions.
- [Create user-site assignment](https://docs.voltview.co.uk/api-reference/user/create-user-site-assignment.md): Assign a user to a specific site. Requires admin permissions.
- [Delete user-site assignment](https://docs.voltview.co.uk/api-reference/user/delete-user-site-assignment.md): Remove a user's access to a specific site. Requires admin permissions.
- [List all sites](https://docs.voltview.co.uk/api-reference/sites/list-all-sites.md): Retrieves all sites associated with the authenticated user
- [Create a new site](https://docs.voltview.co.uk/api-reference/sites/create-a-new-site.md): Create a new site in the system.
- [Address lookup](https://docs.voltview.co.uk/api-reference/sites/address-lookup.md): Look up addresses by postcode
- [Peak demand for all sites](https://docs.voltview.co.uk/api-reference/sites/peak-demand-for-all-sites.md): Retrieves peak power demand data across all sites
- [Annual consumption and emissions for all sites](https://docs.voltview.co.uk/api-reference/sites/annual-consumption-and-emissions-for-all-sites.md): Retrieves annual energy consumption and emissions data across all sites
- [Annual spend and savings for all sites](https://docs.voltview.co.uk/api-reference/sites/annual-spend-and-savings-for-all-sites.md): Retrieves annual energy spending and cost savings data across all sites
- [Tariffs for all sites](https://docs.voltview.co.uk/api-reference/sites/tariffs-for-all-sites.md): Retrieves energy tariff information across all sites
- [Invoices for all sites](https://docs.voltview.co.uk/api-reference/sites/invoices-for-all-sites.md): Retrieves invoice information across all sites
- [Reports for all sites](https://docs.voltview.co.uk/api-reference/sites/reports-for-all-sites.md): Retrieves energy reports across all sites
- [Energy cost data for all sites](https://docs.voltview.co.uk/api-reference/sites/energy-cost-data-for-all-sites.md): Retrieves energy cost data across all sites
- [Energy intensity for all sites](https://docs.voltview.co.uk/api-reference/sites/energy-intensity-for-all-sites.md): Retrieves energy intensity metrics across all sites
- [Statistics for all sites](https://docs.voltview.co.uk/api-reference/sites/statistics-for-all-sites.md): Retrieves statistical data across all sites
- [Energy recommendations](https://docs.voltview.co.uk/api-reference/sites/energy-recommendations.md): Retrieves energy efficiency recommendations
- [On-site assets](https://docs.voltview.co.uk/api-reference/on-site-assets/on-site-assets.md): List solar systems and batteries mapped to the authenticated user's sites. v1 is read-only: VoltView pulls generation and storage from the inverter or installer portal and does not charge, discharge, or change setpoints.
- [Solar](https://docs.voltview.co.uk/api-reference/on-site-assets/solar.md): Read-only solar generation for arrays mapped to a site and its import MPAN. Returns instantaneous AC power, interval generation, yield, and status from the inverter portal. Derived self-consumption and export are labelled as derived.
- [Batteries](https://docs.voltview.co.uk/api-reference/on-site-assets/batteries.md): Read-only battery state of charge and charge/discharge power. A battery is one storage system on a site, mapped to the same import MPAN as the solar it sits with if any. VoltView does not dispatch the battery.
- [Get site meters](https://docs.voltview.co.uk/api-reference/meters/get-site-meters.md): Retrieve all meters associated with a specific site.
- [Create meter](https://docs.voltview.co.uk/api-reference/meters/create-meter.md): Create a new meter for a site. Requires admin permissions.
- [Delete meter](https://docs.voltview.co.uk/api-reference/meters/delete-meter.md): Delete a specific meter. Requires admin permissions. User must have access to the site where the meter is located.
- [Lookup meters by postcode](https://docs.voltview.co.uk/api-reference/meters/lookup-meters-by-postcode.md): Search for meters by postcode. Returns a list of addresses with their corresponding addressIds. Requires hasMeterLookup permission.
- [Get meter details by address ID](https://docs.voltview.co.uk/api-reference/meters/get-meter-details-by-address-id.md): Retrieve full meter details using the addressId from the postcode search. Returns MPAN/MPRN, supplier info, EAC data, and address details. Requires hasMeterLookup permission.
- [Bulk meter lookup](https://docs.voltview.co.uk/api-reference/meters/bulk-meter-lookup.md): Look up multiple meters at once for a specific customer. Maximum 50 lookups per request. Efficiently uses cache to avoid repeat API calls. Requires hasMeterLookup permission.
- [Get meter reads](https://docs.voltview.co.uk/api-reference/meters/get-meter-reads.md): List meter reads for a meter with optional date range filtering and pagination.
- [Create meter read](https://docs.voltview.co.uk/api-reference/meters/create-meter-read.md): Create a new meter read.
- [Delete meter read](https://docs.voltview.co.uk/api-reference/meters/delete-meter-read.md): Delete a specific meter read.
- [Emissions data for all sites](https://docs.voltview.co.uk/api-reference/emissions/emissions-data-for-all-sites.md): Retrieves carbon emissions data across all sites
- [Marginal carbon intensity](https://docs.voltview.co.uk/api-reference/emissions/marginal-carbon-intensity.md): Retrieves marginal carbon intensity data
- [Emissions data for a specific site](https://docs.voltview.co.uk/api-reference/emissions/emissions-data-for-a-specific-site.md): Retrieves carbon emissions data for a specific site
- [Degree days for a specific site](https://docs.voltview.co.uk/api-reference/emissions/degree-days-for-a-specific-site.md): Get degree days data for weather normalization analysis.
- [Annual consumption and emissions for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/annual-consumption-and-emissions-for-a-specific-site.md): Retrieves annual energy consumption and emissions data for a specific site
- [Annual spend and savings for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/annual-spend-and-savings-for-a-specific-site.md): Retrieves annual energy spending and savings data for a specific site
- [Peak demand for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/peak-demand-for-a-specific-site.md): Retrieves peak power demand data for a specific site
- [Tariffs for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/tariffs-for-a-specific-site.md): Retrieves energy tariff information for a specific site
- [Reports for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/reports-for-a-specific-site.md): Retrieves energy reports for a specific site
- [Statistics for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/statistics-for-a-specific-site.md): Retrieves statistical data for a specific site
- [Energy intensity for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/energy-intensity-for-a-specific-site.md): Retrieves energy intensity metrics for a specific site
- [Energy cost data for a specific site](https://docs.voltview.co.uk/api-reference/specific-site/energy-cost-data-for-a-specific-site.md): Retrieves energy cost data for a specific site
- [Load curve for all sites](https://docs.voltview.co.uk/api-reference/energy-consumption/load-curve-for-all-sites.md): Retrieves load curve data across all sites
- [Load curve for a specific site](https://docs.voltview.co.uk/api-reference/energy-consumption/load-curve-for-a-specific-site.md): Retrieves load curve data for a specific site
- [Time series data for all sites](https://docs.voltview.co.uk/api-reference/energy-consumption/time-series-data-for-all-sites.md): Retrieves time series energy data across all sites
- [Time series data for a specific site](https://docs.voltview.co.uk/api-reference/energy-consumption/time-series-data-for-a-specific-site.md): Retrieves time series energy data for a specific site
- [List available suppliers](https://docs.voltview.co.uk/api-reference/supplier-integration/list-available-suppliers.md): Retrieves a list of all available energy suppliers that can be integrated with
- [Get all accounts](https://docs.voltview.co.uk/api-reference/supplier-integration/get-all-accounts.md): Get all accounts under the projects.
- [Create an Account](https://docs.voltview.co.uk/api-reference/supplier-integration/create-an-account.md): Create an account with credentials for the utility website. The service will use these details to log in and scrape data.
- [Get sites and meters for a business](https://docs.voltview.co.uk/api-reference/supplier-integration/get-sites-and-meters-for-a-business.md): Returns all sites and meters for a business, organised by supplier account. Each site includes its supply types (electricity/gas) and associated meter details (MPAN/MPRN and serial numbers).
- [Get Account Details](https://docs.voltview.co.uk/api-reference/supplier-integration/get-account-details.md): Retrieve the account credentials stored in the system for a specific account ID.
- [Update Account Details](https://docs.voltview.co.uk/api-reference/supplier-integration/update-account-details.md): Update the account credentials stored in the system for a specific account ID.
- [Delete an Account](https://docs.voltview.co.uk/api-reference/supplier-integration/delete-an-account.md): Remove an account from the system.
- [Upload Document to Account](https://docs.voltview.co.uk/api-reference/supplier-integration/upload-document-to-account.md): Upload a document to a specific account for processing and storage.
- [Get Sites Associated with an Account](https://docs.voltview.co.uk/api-reference/supplier-integration/get-sites-associated-with-an-account.md): Fetch all utility sites linked to the specified account.
- [Submit meter reading to supplier](https://docs.voltview.co.uk/api-reference/supplier-integration/submit-meter-reading-to-supplier.md): Submit a meter reading to the supplier (Octopus Energy, E.ON Next, British Gas Lite). The reading is saved to Firestore with status PENDING first, then sent to the supplier; the document is updated to SUCCESS or FAILED. Supports single-register (gas or single-rate electricity), day/night (2 register…
- [Get Supplier Accounts for a Business](https://docs.voltview.co.uk/api-reference/supplier-integration/get-accounts-associated-with-a-business.md): Get all supplier accounts associated with a business. Alternative path using businessId.
- [Get Accounts Associated with a Business](https://docs.voltview.co.uk/api-reference/supplier-integration/get-supplier-accounts-for-a-business.md): Fetch all accounts associated with a specific business.
- [Get Signed Document URL](https://docs.voltview.co.uk/api-reference/supplier-integration/get-signed-document-url.md): Generate a signed URL for accessing a specific document.
- [Request utility integration](https://docs.voltview.co.uk/api-reference/supplier-integration/request-utility-integration.md): Request integration with a utility supplier.
- [Parse LOA (Preview)](https://docs.voltview.co.uk/api-reference/loa-management/parse-loa-preview.md): Parse a Letter of Authority document without saving. Use this to preview extracted data before committing. Returns customer info, authorized persons, supply points (MPANs/MPRNs), and validity period.
- [List LOAs](https://docs.voltview.co.uk/api-reference/loa-management/list-loas.md): List all LOAs for the user's business. Supports filtering by status and pagination. Returns LOA summary with counts of authorized persons and supply points.
- [Create LOA](https://docs.voltview.co.uk/api-reference/loa-management/create-loa.md): Parse and save a Letter of Authority document. Uploads PDF to storage, links supply points to existing meters (if found), and saves to database. Uses content-based deduplication (returns existing LOA if identical file was already uploaded). Triggers background onboarding stages after saving.
- [Get LOA](https://docs.voltview.co.uk/api-reference/loa-management/get-loa.md): Get full details of a specific LOA including authorized persons, supply points with linked meters, and business information.
- [Update LOA status](https://docs.voltview.co.uk/api-reference/loa-management/update-loa-status.md): Update the status of an LOA. Valid statuses: PENDING, SENT, SIGNED, EXPIRED, REJECTED.
- [Get LOA document](https://docs.voltview.co.uk/api-reference/loa-management/get-loa-document.md): Get a signed URL to download the LOA PDF document. URL expires after 1 hour.
- [Parse invoice](https://docs.voltview.co.uk/api-reference/bill-validation/parse-invoice.md): Uploads and processes a UK energy supplier invoice (PDF or images) to extract invoice details, supply points (MPANs/MPRNs), and associated consumption and charge information.
- [Parse contract](https://docs.voltview.co.uk/api-reference/bill-validation/parse-contract.md): Upload and process a UK energy supplier contract (PDF or images) to extract contract details, supply points (MPANs/MPRNs), and associated tariff information.
- [Validate invoice](https://docs.voltview.co.uk/api-reference/bill-validation/validate-invoice.md): Validates an invoice against contract data and optional user-provided consumption data. Performs comprehensive validation including consumption matching, meter reading verification, and check against contract.
- [Delete invoice](https://docs.voltview.co.uk/api-reference/bill-validation/delete-invoice.md): Delete a specific invoice from the system.
- [Update invoice status](https://docs.voltview.co.uk/api-reference/bill-validation/update-invoice-status.md): Update the status of a specific invoice.
- [List your API key metadata](https://docs.voltview.co.uk/api-reference/api-keys/list-your-api-key-metadata.md)
- [Create a personal scoped read key](https://docs.voltview.co.uk/api-reference/api-keys/create-a-personal-scoped-read-key.md)
- [Rotate your API key](https://docs.voltview.co.uk/api-reference/api-keys/rotate-your-api-key.md)
- [Revoke your API key](https://docs.voltview.co.uk/api-reference/api-keys/revoke-your-api-key.md)

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.