API Reference

The Openvolt API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

An important construct on the Openvolt platform is the concept of a meter. In the real world, each meter is assigned a "meter number" by the Electricity Network (In the UK, this is typically called an MPAN). This number is unique to physical meters on that network. This is used for tracking consumption or generation of electricity across the network. Also in the real world, multiple parties may have access or "consent" to access the data coming from this meter.

On the Openvolt platform, a meter is a digital representation of the physical meter that's on the side of your customer's building. It also includes information such as

  • Who we are accessing this meter data on_behalf_of (customer)
  • The consent information that is needed for that party to access the data (consent)
  • The schedule on how often the data is refreshed on the meter (schedule)
  • The source of the centralised datasource that the meter feeds into
  • Physical address and other information
  • and other stuff

It's important to note, that it is possible to have multiple meters with the same meter_number if you are accessing data on_behalf_of different customers