Skip to main content
POST
/
prices
Retrieve a price
curl --request POST \
  --url https://api.flatpeak.com/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "loc_641b90b758fb8e6293716e40",
  "end_time": "2023-06-15T23:00:00Z",
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "tariff_direction": "IMPORT",
  "start_time": "2023-06-15T09:00:00Z"
}
'
{
  "id": "prs_65e42cdd73e9f861edda35d7",
  "object": "price",
  "location_id": "loc_65e42ce4d3b813479b252160",
  "live_mode": true,
  "location_timezone": "Europe/London",
  "currency_code": "EUR",
  "last_updated": "2022-05-24T14:15:22Z",
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "tariff_direction": "IMPORT",
  "data": [
    {
      "valid_from": "2022-12-28T01:00:00Z",
      "valid_to": "2022-12-28T02:30:00Z",
      "price": {
        "value": 4.998,
        "confidence": 1
      }
    }
  ],
  "time_created": "2022-05-24T15:15:22Z",
  "account_id": "acc_661677911f2197045e6cf1b1"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Body

application/json
​
location_id
string
required

Flatpeak Location ID

Example:

"loc_641b90b758fb8e6293716e40"

​
end_time
string<date-time>
required

RFC 3339 timestamp marking the end of the data window, e.g. 2023-06-15T13:00:00Z or 2023-06-15T12:00:00+01:00; use either UTC or time offset—if offsets differ, end_time takes precedence; max range is 90 days.

Example:

"2023-06-15T23:00:00Z"

​
device_id
string

Flatpeak Device ID

Example:

"dev_63a6087272941ef077a8fd3e"

​
tariff_direction
string

Specifies the tariff direction; set to IMPORT, EXPORT, or LOCAL. Defaults to IMPORT.

Example:

"IMPORT"

​
start_time
string<date-time>

RFC 3339 timestamp marking the start of the data window, e.g. 2023-06-15T09:00:00Z or 2023-06-15T08:00:00+01:00; use either UTC or time offset—if offsets differ, end_time takes precedence.

Example:

"2023-06-15T09:00:00Z"

Response

This object is a container for energy rates response.

​
id
string
required

Flatpeak unique object id.

Example:

"prs_65e42cdd73e9f861edda35d7"

​
object
string
required

Represents the object's type. I.e. price.

Example:

"price"

​
location_id
string
required

The unique Flatpeak ID of the location.

Example:

"loc_65e42ce4d3b813479b252160"

​
live_mode
boolean
required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

​
location_timezone
string
required

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

Example:

"Europe/London"

​
currency_code
string
required

Currency at the location in ISO 4217.

Example:

"EUR"

​
last_updated
string
required

Time when rates were last updated. In the format of the request, e.g. UTC or time-offset.

Example:

"2022-05-24T14:15:22Z"

​
device_id
string

Flatpeak device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

​
tariff_direction
string

Direction of tariff. Supported options are IMPORT, EXPORT.

Example:

"IMPORT"

​
data
object[]

Rates response data.

​
time_created
string<date-time>

Time when this response was calculated. In UTC.

Example:

"2022-05-24T15:15:22Z"

​
account_id
string

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"