Skip to content

Voltmasters Platform

API

The public REST API of the Voltmasters platform: read a project's data and act on it from your own reporting, billing or building management system.

The platform has a public REST API so your own software can read a project's data and, where it applies, act on it. Everything you can see on the dashboards has a counterpart in the API, which makes it the way to feed Voltmasters data into your own reporting, billing or building management system.

Typical users are home automation systems, reporting tools and custom integrations.

What the API covers

The API is scoped per project and covers, among other things:

Area What you can read
Devices The devices of the project, with their identifiers to use in the other calls.
Energy meters Import and export energy per quarter-hour, plus the peak import and export power within each quarter.
EV charging The energy charged per charge point per quarter-hour, and the individual charging sessions with their energy, peak power and state of charge.
PV production The energy each inverter produced per quarter-hour, and the highest power it reached within each quarter.
Battery The energy each battery took in and gave back per quarter-hour, with its state of charge at the start and the end of the quarter.
Consumption What the whole site consumed per quarter-hour, split into the part drawn from the grid and the part it covered with its own production.
Forecasts The forecasts the EMS works with.
Energy prices The published EPEX day-ahead prices per bidding domain, with averages and peak and off-peak figures. This endpoint needs no authentication.
Incidents The incidents of the project.
Manual overrides The manual overrides on a device, and starting or stopping one.
EMS controller The state of the controller of the project.

API documentation

The full reference, with every endpoint, its parameters, the response shapes and usage examples, lives at:

https://platform.voltmasters.be/docs/general/api 

You can also reach it with the API documentation button under Settings → API keys.

Creating an API key

Access is granted with an API key. A key is scoped to one project and grants the permissions needed to read or write that project's data.

  1. Navigate to Settings → API keys.
  2. Under Create API key, enter a recognisable name, for example Home automation integration or Reporting script.
  3. Click Create key.
  4. The secret is displayed only once, at the moment of creation. Copy it immediately and store it in a safe place. It cannot be retrieved again.

If you lose the secret, you will need to create a new API key and update any integrations that use the old one.

Existing keys are listed on the same page with the date they were created. Delete removes a key; any integration still using it stops working straight away.