Quickstart

This guide takes you from an API key to the prices for one device. The examples use curl.

Authenticate

Copy your Account ID and secret key from Console > API Keys. Use a Live mode key. If you have no account, create one, then contact support to activate your trial.Base64 encode account_id:secret_key and create a token. The token lasts one hour.

curl --request POST \
  --url https://energy-api.flatpeak.com/auth/tokens \
  --header 'Authorization: Basic <base64 encoded account_id:secret_key>'

{
  "bearer_token": "eyJhbGciOiJIUzI1NiIsInR5cC",
  "expires_in": 3600,
  "live_mode": true
}

Create a user, location and device

Create a user.

curl --request POST \
  --url https://energy-api.flatpeak.com/users \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json'

{
  "id": "usr_65e421d1daa4a24082b4f590",
  "object": "user"
}

Create a location with the user_id.

curl --request POST \
  --url https://energy-api.flatpeak.com/locations \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "usr_65e421d1daa4a24082b4f590"
}'

{
  "id": "loc_641b90b758fb8e6293716e40",
  "object": "location"
}

Create a device with the location_id and a device_type: BATTERY_STORAGE, ELECTRIC_VEHICLE, EV_CHARGER, AIR_CONDITIONER, HEAT_PUMP, WATER_HEATER, PV_SYSTEM, POWER_GENERATOR or OTHER.

curl --request POST \
  --url https://energy-api.flatpeak.com/devices \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "location_id": "loc_641b90b758fb8e6293716e40",
  "device_type": "BATTERY_STORAGE"
}'

{
  "id": "dev_9c1f70a4e2b6485db3f0c8a1",
  "object": "device",
  "device_type": "BATTERY_STORAGE",
  "location_id": "loc_641b90b758fb8e6293716e40"
}

Create a Connect session

A Connect session is a single-use key that launches Connect without exposing your secret key. Create a Connect session with:

Field	Value
`device_id`	The device from the previous step
`connect_url`	Where Connect is hosted. Use `https://busbar.connect-web.flatpeak.com`
`callback_url`	Where the user lands after Connect. Use `myapp://flatpeak/complete`

curl --request POST \
  --url https://energy-api.flatpeak.com/connect-sessions \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "device_id": "dev_9c1f70a4e2b6485db3f0c8a1",
  "connect_url": "https://busbar.connect-web.flatpeak.com",
  "callback_url": "myapp://flatpeak/complete"
}'

{
  "id": "cos_6587fa4362341be5b524de3b",
  "object": "connect_session",
  "live_mode": true,
  "time_created": "2026-06-15T09:00:00Z",
  "time_expiry": "2026-06-17T09:00:00Z"
}

Launch the Connect web app in Tariff mode

Open the hosted Connect web app with the session id and flow=TARIFF:

https://busbar.connect-web.flatpeak.com/?connect_session=cos_6587fa4362341be5b524de3b&flow=TARIFF

The user picks their supplier, signs in, grants access to their tariff and returns to your app. A session expires after 48 hours and launches Connect once, so create a new one for every launch.

Flatpeak Connect flow — Connect in Tariff mode

Use your own account with a supported supplier. To test the supplier login, pick one with a Direct connection, or switch to a test mode key and use the test supplier Antarctic Energy.

Get prices

Retrieve the device price.

curl --request GET \
  --url 'https://energy-api.flatpeak.com/devices/dev_9c1f70a4e2b6485db3f0c8a1/prices?start_time=2026-06-15T09:00:00Z&end_time=2026-06-15T23:00:00Z' \
  --header 'Authorization: Bearer <bearer_token>'

{
  "object": "price",
  "device_id": "dev_9c1f70a4e2b6485db3f0c8a1",
  "timezone": "Europe/London",
  "currency_code": "GBP",
  "data": {
    "import": [
      {
        "start_time": "2026-06-15T09:00:00Z",
        "end_time": "2026-06-15T11:00:00Z",
        "price": {
          "value": 0.14998,
          "confidence": 1
        }
      },
      {
        "start_time": "2026-06-15T11:00:00Z",
        "end_time": "2026-06-15T23:00:00Z",
        "price": {
          "value": 0.23072,
          "confidence": 0.8
        }
      }
    ],
    "export": []
  }
}

Next steps

Connect: put the flow in your app.
Prices and costs: prices, costs and price updates.
Optimizations: the best times to run a device.
VPP quickstart: enroll the device in a program.

Get started

Tariffs

VPP

Platform