Our products

Getting started

[accountId]:[apiKey]

FlatPeak

Tutorials

Guides

API Reference

Legal

Home

Dashboard

Support

FlatPeak is an energy tariff data and optimisation platform that connects you to your customer's actual electricity tariff. It enables you to optimise your devices to use lower-cost energy and report monetary savings.

Introduction

In this tutorial, you will learn how to leverage FlatPeak to optimise the operation of your devices to reduce your customers’ energy costs and demonstrate savings.

FlatPeak for your use case

It only takes two steps to integrate FlatPeak into your app and back-end before you can start making requests for your customer's energy tariff.

Service architecture

Before implementing Connect integration, you can use the FlatPeak-hosted version of Connect to quickly test the experience it provides.

Testing Connect

In this tutorial, you will learn how to integrate the web version of Connect, the **Connect-web** into your application.

Single-page web app

Single-page web app Tutorial

In this tutorial, you will learn how to integrate the JSON version of *Connect*, the **Connect-headless**, natively into your application.

Native app or Server-side

Native app or server-side Tutorial

In this tutorial, you will learn how to build a page in your app to enable your customers to quickly add, check status and manage tariff connections.

Displaying tariff settings

Tariff settings in your app

Once your customer has completed the Connect flow, you can use Connect to display the summary of their tariff inside your app.

Displaying tariff summary

Displaying customer's tariff in your app

Once your customer has completed the Connect flow, FlatPeak systems will kick in to automatically keep their tariff information up to date.

Implementing tariff lifecycle

Implementing tariff lifecycle webhooks

In this tutorial, you will learn how to import and manage your customer's tariffs in FlatPeak when you cannot use [Connect](/guides/connect-integration-test).

Managing tariffs via API

Using API to create and manage tariffs

In this tutorial, you will learn how obtain your customer's tariff rates and use it to calculate your customer's energy cost.

Getting tariff rates

In this tutorial, you will learn how to lower your device's energy cost by aligning its operation with price of energy in real-time with FlatPeak Copilot Schedules.

Scheduling energy use

Shifting energy use to lower the cost

In this tutorial, you will learn how to calculate the cost of energy that your device is using (or exporting) at your customer's premises.

Calculating energy cost

In this tutorial, you will learn how to account for local generation in FlatPeak service.

Accounting local generation

In this tutorial, you will learn how to use FlatPeak API to calculate carbon footprint of your devices, in addition to the monetary cost of energy they use.

Reporting CO2

Reporting carbon intensity

Authorization

API Authorization

Test mode is an isolated environment in your FlatPeak account that enables you to develop and test your integration without affecting your production data.

Test mode

Pagination

Events

Webhooks

Deletions

Objects deletion

Errors

Device identifiers

Creating device identifiers

Market rates

How FlatPeak supports dynamic market rates

Energy provider integration

How to develop FlatPeak provider integration

Terms of Service

Service Level Agreement

Support Policy

Data Processing Agreement

Privacy Statement

Data Disclosure Policy

Acceptable Use Policy

FlatPeak API uses [bearer authentication](/help/api-authorization) (also called token authentication) to authorize access to API endpoints. To create a bearer token, use this `/login` endpoint with basic auth:

  | []()            | []()                                                                   
  | --------------- | ------------------------------ |
  | `username`      | Your FlatPeak Account ID.      |
  | `password`      | Any of your FlatPeak API Keys. |

<Tip>Account ID and API Keys can be found on [API Keys](https://dashboard.flatpeak.com/keys/api) page of Dashboard.</Tip>

Create a bearer token

In order launch a session with Connect you need a `connect_token`. 

Connect tokens serve single purpose of authenticating your customer's session with Connect and are dismissed as soon as you [exchanged](/api-reference/connect/exchange-a-connect-token) the token for `location_id` once your customer's session with Connect has ended.

<Info>Refer to [Connect-web](/guides/connect-web-tariff) and [Connect-headless](/guides/connect-headless-tariff) to learn how to implement Connect with your application.</Info>

Create a token

Create a connect token

To start requesting your customer's tariff rates from this API, you need to exchange the `connect_token` for a `location_id`.

Exchange a token

Exchange a connect token

Lists events, going back up to 90 days.

Events are returned sorted by creation date, with the most recent appearing first. If no parameters are specified in the request, all events in pages of 100 are returned.

List all events

Retrieve an event

Returns a list of all customers. 

The objects are returned sorted by creation date, with the most recent appearing first. If no parameters are specified in the request, all objects in pages of 100 are returned.

List all customers

Retrieves the details of an existing customer.

Retrieve a customer

Creates new customer.

<Warning>Do not create customers via this endpoint unless you are performing a bulk import from your system or have been advised by FlatPeak support. Instead, use [Connect](/guides/integration-plan), which will automatically create customers as part of its flow.</Warning>

Create a customer

Updates the specified customer. Any parameters not provided will be left unchanged.

Update a customer

Delete a customer

<Info>Location is an identifier of a supply address.</Info>

Returns list of all Locations.

The objects are returned sorted by creation date, with the most recent appearing first. If no parameters are specified in the request, all objects in pages of 100 are returned.

List locations

Retrieve a location

<Info>Location is an identifier of a supply address.</Info>

Creates a location.

Create a location

Updates the specified location. Any parameters that have not been provided will be left unchanged.



Update a location

Delete a location

Returns list of all tariffs. Use this to read tariff objects listed in tariff_elements property of Location.

The objects are returned sorted by creation date, with the most recent appearing first. If no parameters are specified in the request, all objects in pages of 100 are returned.

List tariffs

Creates a tariff. Use this endpoint to manually create a tariff and link it to a Location. Useful when you are importing data to FlatPeak.

Create a tariff

Retrieves the details of an existing tariff. Use this endpoint to via details of a specific tariff listed in `tariff_elements` property of the Location object.


Retrieve a tariff

Deletes a tariff. Will also automatically remove tariff from `tariff_elements` property of the Location object it is associated with.

Delete a tariff

List all devices

Retrieves the details of an existing device identifier.

Retrieve a device

Create a device

Updates the specified device identifier. Any parameters that have not been provided will be left unchanged.

Update a device

Delete a device

Accepts array of meter records holding energy use values for each period.

- If you are metering a device, submit records under `device_id`.
- If you are metering a location (i.e. main supply address meter), submit records under `location_id`.

Submit interval

Submit interval meter records

Accepts array of meter records holding energy use as cumulative values.

- If you are metering a device, submit records under `device_id`.
- If you are metering a location (i.e. main supply address meter), submit records under `location_id`.

Submit cumulative

Submit cumulative meter records

Returns processing status of meter records batch when multiple records were submitted to meters endpoints.

Check batch status

Check submission batch status

Ingests a meter record and instantly returns import or export monetary value (cost) of energy.

- If you are metering a device, submit records using `device_id` parameter.
- If you are metering a location (i.e. main supply address meter), submit records under `location_id` parameter.

<Info>Meter records that are submitted via this endpoint will be permanently stored and will be used for other cost-calculations endpoints.</Info>

Instantly on-demand

Instantly calculate energy cost

Returns monetary value (cost) of energy by FlatPeak `location_id` or `device_id`. Meter records must have been previously submitted to the `/meters` endpoint.

By time interval

Calculate energy cost by time interval

Returns monetary value (cost) of energy by `session_reference_id` that have been previously submitted to a /meters endpoint.

By session id

Calculate energy cost by session ID

Returns raw tariff rates in time series format, by Location ID.

Get raw tariff rates

<Note>This endpoint is in invite-only beta. [Request access](https://forms.gle/jyoPr3rihseywr988).</Note>

Returns audit of tariff rates calculation, by Location ID.

Audit tariff rates

<Note>This endpoint is in invite-only beta. [Request access](https://forms.gle/jyoPr3rihseywr988).</Note>

Returns a time slot that when tariff is highest or lowest, over requested time period. 

*Userful when you need 5 hours of lowest price time over a given day. Slot might be split into a multiple segments.*

Amount of time

Get usage slots for required time amount

<Note>This endpoint is in invite-only beta. [Request access](https://forms.gle/jyoPr3rihseywr988).</Note>

Returns time slots were tariff rate is below or above target level, by Location ID. 

*Userful when you need to provide, say, 5 hours of charging time between 9pm and 6am when price is lowest.*

Getting Started

Connect Tutorials

API Tutorials

Introduction

Our products

Tariff Connect

Tariff Rates

Cost Report

Copilot Schedule

Getting started

Getting Started

Connect Tutorials

API Tutorials

​Our products

Tariff Connect

Tariff Rates

Cost Report

Copilot Schedule

​Getting started

Our products

Getting started