Skip to main content
GET
/
devices
/
{id}
/
state
Retrieve a device state
curl --request GET \
  --url https://api.flatpeak.com/devices/{id}/state \
  --header 'Authorization: Bearer <token>'
{
  "id": "dsr_6a284b7596d3f2b722544e70",
  "object": "device_state",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "time": "2022-02-01T10:30:00Z",
  "state_of_charge_percent": 34.2,
  "time_created": "2022-02-01T10:33:00Z",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "target_state_of_charge_percent": 80,
  "battery_power_kw": -3.4,
  "energy_remaining_kwh": 8.3,
  "backup_reserve_percent": 20,
  "record_reference_id": "MET1234567890"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Path Parameters

​
id
string
required

Flatpeak device_id.

Response

Example response

​
id
string
required

Flatpeak device state record ID.

Example:

"dsr_6a284b7596d3f2b722544e70"

​
object
string
required

Flatpeak object name, e.g. device_state.

Example:

"device_state"

​
location_id
string
required

Flatpeak location_id where device is located.

Example:

"loc_641b90b758fb8e6293716e40"

​
time
string<date-time>
required

Time the measurement was recorded, in RFC3339 format.

Example:

"2022-02-01T10:30:00Z"

​
state_of_charge_percent
number
required

Current battery state of charge as a percentage from 0 to 100.

Example:

34.2

​
time_created
string<date-time>
required

Time when this object was created. In UTC.

Example:

"2022-02-01T10:33:00Z"

​
account_id
string
required

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

​
target_state_of_charge_percent
number

Target battery state of charge as a percentage from 0 to 100.

Example:

80

​
battery_power_kw
number

Current battery power in kilowatts. Positive values indicate charging, negative values indicate discharging.

Example:

-3.4

​
energy_remaining_kwh
number

Estimated usable energy currently available in the battery, in kilowatt-hours.

Example:

8.3

​
backup_reserve_percent
number

Percentage of battery capacity reserved for backup and unavailable for optimisation or dispatch.

Example:

20

​
record_reference_id
string

Optional unique identifier for the telemetry record, used for idempotency and reconciliation.

Example:

"MET1234567890"