​
Introduction

FlatPeak supports both device-level and location-level metering and cost calculations. You can send meter records from your device or property meter to FlatPeak API and get the cost of that energy back in real-time or aggregated by session/day/month/year.

​
Device level calculation

Here is how you can get the cost of energy for your device calculated using FlatPeak API:

Before you begin, you need to obtain a FlatPeak identifier for your device. Follow the creating device identifiers article to learn how to do this. Once you have the FlatPeak device identifier, the device_id, you can get its energy cost calculated in two ways:

Use instant-cost-calculate endpoint to submit metering records and instantly get the cost of that energy. Your API request will look similar to the example below. The response will include your original request and monetary energy cost in the tariff object:

​
Location level calculation

FlatPeak also supports location-level metering for energy cost calculation. You can submit records from the property meter and get FlatPeak to calculate the energy cost using the grid tariff at that supply address.

The flow for submitting meter records is similar to the process for devices, but do not include the device_id to attribute the readings to a property meter and not a device meter:

You can also submit location-level meter records to instant-cost-calculate endpoint.

Please contact support or directly schedule a call with our customer success team if you would like to discuss planning your integration with FlatPeak.

Was this page helpful?

Device identifiersCalculating carbon