Skip to main content
GET
Retrieve a device state

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Response

Device state response.

The most recent operational state of a device: the live envelope at the grid connection point. Flatpeak computes it from what the OEM submits, so inverter limits, the backup reserve and current conditions are already accounted for.

object
enum<string>
default:device_state
required

Object type, device_state.

Available options:
device_state
Example:

"device_state"

device_id
string
required

Flatpeak Device ID of the device this state belongs to.

Example:

"dev_63a6087272941ef077a8fd3e"

oem_id
string
required

Flatpeak OEM ID: the OEM that submitted the state.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"

time_recorded
string<date-time>
required

Time when the measurement was recorded, in UTC.

Example:

"2026-07-08T19:30:00Z"

available
boolean
required

true when the device can be dispatched now. false while islanded, holding charge for a storm, or otherwise unable to follow instructions.

Example:

true

power_kw
number
required

Power at the grid connection point, in kW. Positive is import, negative is export.

Example:

-3.4

state_of_charge_percent
number | null
required

Current usable state of charge of the dispatchable storage as a percentage from 0 to 100. For EV_CHARGER devices, the connected vehicle's state of charge. null for a device with no dispatchable storage.

Required range: 0 <= x <= 100
Example:

34.2

available_import_energy_kwh
number | null
required

Energy the device can absorb before storage is full, in kWh. null for a device with no dispatchable storage.

Required range: x >= 0
Example:

5.9

available_export_energy_kwh
number | null
required

Energy available for export above the backup reserve, in kWh. null for a device with no dispatchable storage.

Required range: x >= 0
Example:

5.5