FlatPeak supports real-time or batch energy cost calculation at both device and locaiton (i.e. property address) levels.

​
Device-level cost calculation

1

Create device identifier

Start by creating a device_id via create-a-device endpoint. This will be used to tag meter records.
2

Submit meter records & get cost

  • To instantly calculate energy cost, use the instant-cost-calculate endpoint, include the device_id that you created in the previous step.
  • To submit a series of records use interval or cumulative endpoints. Then use interval or session-id endpoints to obtain energy cost, include the device_id too.

​
Location-level cost calculation

FlatPeak supports cost reporting at the location level. Submit meter readings with a location_id (no device_id), and FlatPeak will calculate energy cost using the tariff linked to that location. Use the same API flow as for device-level cost calculation—just omit the device_id.

​
Simulating energy cost profiles

If you need to model energy cost scenarios, pass non_persistent with your request to instant-cost-calculate endpoint. This will enable you to estimate energy cost without affecting actual consumption data.