Skip to content

Voltmasters Platform

API

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

The platform has a public REST API. Your own software reads a project's data with it and, where possible, can act on it. This is how you feed Voltmasters data into your own reporting, invoicing or building management.

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

What the API covers

The API works per project. Much of the data is available per quarter hour.

Component What you can read
Devices The devices of the project, with the identifiers you use in the other calls.
Energy meters The energy imported and exported per quarter hour, plus the highest import and export power within each quarter hour.
EV charging The energy charged per charge point per quarter hour, and the charging sessions with energy, peak power and state of charge. You filter by time window, charge point and session status; the newest sessions come first.
PV production The energy each inverter produced per quarter hour, and the highest power it reached within each quarter hour.
Battery The energy each battery charged and discharged per quarter hour, with the state of charge at the start and end of the quarter hour.
Consumption What the whole site consumed per quarter hour, split into the part from the grid and the part from its own production. Also the forecast and measured outside temperature per hour.
Forecasts All forecast data the EMS uses.
Energy prices The published EPEX day-ahead prices per bidding zone, with averages and peak and off-peak figures. This endpoint does not require authentication.
Incidents The incidents of the project.
Manual overrides The manual overrides on a device.
EMS controller The state of the project's controller.

The integration API for partners, with webhooks, is a separate API. It is not covered on this page.

API documentation

The full reference, with every endpoint, its parameters, the shape of the responses and examples, is here:

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

You get access with an API key. A key applies to one project and gives the rights needed to read or write that project's data.

  1. Go to Settings → API keys.
  2. Under API key creation, enter a recognisable name, for example Home automation integration or Reporting script.
  3. Click Create key.
  4. The secret is shown only once, at the moment you create it. Copy it straight away and store it somewhere safe. It cannot be retrieved later.

If you lose the secret, you must create a new API key and update every integration that uses the old one.

The existing keys are on the same page, with their creation date. Use Delete to remove a key; an integration that still uses it stops working.