Skip to main content
GET
Audit a device price

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

Query Parameters

start_time
string<date-time>
required

RFC 3339 timestamp marking the start of the data window, for example 2026-06-15T09:00:00Z or 2026-06-15T08:00:00+01:00. Use either UTC or a time offset. If offsets differ, end_time takes precedence.

Example:

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

end_time
string<date-time>
required

RFC 3339 timestamp marking the end of the data window, for example 2026-06-15T13:00:00Z or 2026-06-15T12:00:00+01:00. Use either UTC or a time offset. If offsets differ, end_time takes precedence. Maximum range is 90 days.

Example:

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

Response

200 OK: a detailed breakdown of how the energy price was calculated.

id
string
required

Flatpeak ID of this response.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"tra_65e42cdd73e9f861edda35d7"

object
enum<string>
default:price_audit
required

Object type.

Available options:
price_audit
Example:

"price_audit"

device_id
string
required

Flatpeak Device ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"dev_63a6087272941ef077a8fd3e"

location_id
string
required

Flatpeak Location ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"loc_65e42ce4d3b813479b252160"

account_id
string
required

Flatpeak Account ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_661677911f2197045e6cf1b1"

live_mode
boolean
required

true for live data, false for test data.

timezone
string
required

Timezone at the location, tz database name such as Europe/Berlin.

Example:

"Europe/Berlin"

currency_code
string
required

Currency at the location in ISO 4217.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

data
object[]
required

Response data.

time_created
string<date-time>
required

Time when this response was calculated. In UTC.

Example:

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

direction
enum<string>

Direction of energy flow: IMPORT (from grid) or EXPORT (to grid).

Available options:
IMPORT,
EXPORT
Example:

"IMPORT"

time_updated
string<date-time>

Time the underlying rates were last refreshed (distinct from time_created, which is when this response was generated). RFC 3339.

Example:

"2026-05-25T15:15:22Z"