Integrating API

• If you can plan ahead
• If you cannot plan ahead

Call get-tariff-rate-blocks endpoint to obtain information on high tariff periods.

In the example below, the peak tariff period is between 5:30 a.m. and 11 p.m. (tariff.block=2). Instruct your system to supply previously stored energy to your customer’s premises during this period.

If your customer has an export tariff, you can use the create-a-schedule endpoint to find the optimal time to export energy. You will need to know how much energy your system will need and when it will be able to export.

The schedule object in the response contains an export plan that your system can use to maximise monetary value of exported energy.

To calculate the energy cost savings provided by your system, you need to record the cost of energy is stores. Call submit-meter-interval endpoint and metering records (at device-level) when your system is importing the energy. Set direction=IMPORT and tariff_rate=IMPORT.

curl --request PUT \
  --url https://api.flatpeak.com/meters/interval \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[{
  "start_time": "2024-08-02T01:00:00Z",
  "end_time": "2024-08-02T02:00:00Z",
  "device_id": "dev_65e6d8334c8d715963d99db3",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "direction": "IMPORT",
  "tariff_rate": "IMPORT",
  "units": "W",
  "value": 2034
}]'

When your system supplies your customer’s premises with previously stored energy, log it as if it is supplied directly from the grid. Call submit-meter-interval setting direction=EXPORT and tariff_rate=IMPORT.

curl --request PUT \
  --url https://api.flatpeak.com/meters/interval \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[{
  "start_time": "2024-08-01T08:00:00Z",
  "end_time": "2024-08-01T09:00:00Z",
  "device_id": "dev_65e6d8334c8d715963d99db3",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "direction": "EXPORT",
  "tariff_rate": "IMPORT",
  "units": "W",
  "value": 1214
}]'

When your system exports energy to the grid, log it using the export tariff. Call submit-meter-interval endpoint setting direction=EXPORT and tariff_rate=EXPORT.

curl --request PUT \
  --url https://api.flatpeak.com/meters/interval \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[{
  "start_time": "2024-08-01T08:00:00Z",
  "end_time": "2024-08-01T09:00:00Z",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "direction": "EXPORT",
  "tariff_rate": "EXPORT",
  "units": "W",
  "value": 2144
}]'

1. To get the cost of imports: Call calculate-energy-cost-by-interval endpoint to request the cost of imported energy (note the direction=IMPORT) for the period for when you would like to provide the report:

2. To get the value of energy that your system supplied to premises: Then, call calculate-energy-cost-by-interval again to request what would be the cost of energy if your device did not supply it from storage (note the direction=EXPORT); for the same period:

3. To get the value of exports: If your system is exporting energy to the grid, call calculate-energy-cost-by-interval endpoint for the third time to request the value of exported energy (note use of Location ID and direction=EXPORT):

• If your system is not exporting
• If your system is exporting