Skip to main content
GET
/
devices
/
{device_id}
Retrieve a device
curl --request GET \
  --url https://api.flatpeak.com/devices/{device_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "dev_63a6087272941ef077a8fd3e",
  "object": "device",
  "live_mode": true,
  "controlled": true,
  "properties": {
    "manufacturer": "Nova Systems",
    "model_code": "PICOXN2",
    "model_name": "Pico Ultimate",
    "battery": {
      "capacity_kwh": 14.2,
      "power_kw": 7.2,
      "charge_power_kw": 5,
      "discharge_power_kw": 7.2,
      "round_trip_efficiency": 0.9
    },
    "pv": {
      "peak_power_kw": 6.4,
      "azimuth": 0,
      "tilt": 23,
      "terrain_shading": false,
      "forecasts_enabled": false
    },
    "inverter": {
      "ac_export_limit_kw": 5
    },
    "ev_charger": {
      "max_power_kw": 7.4,
      "min_power_kw": 1.4,
      "phases": 1,
      "phase_switching": false,
      "v2g_capable": false
    },
    "heat_pump": {
      "max_power_kw": 3.5,
      "min_power_kw": 0.5,
      "thermal_storage_litres": 200
    },
    "install_date": "2022-03-22T11:12:21Z"
  },
  "consents": {
    "time_updated": "2022-03-22T11:12:21Z",
    "time_created": "2022-03-22T11:12:21Z",
    "information": true,
    "telemetry": true,
    "control": false,
    "geo_location": true
  },
  "timezone": "Europe/London",
  "geo_location": {
    "lat": 50.12345,
    "lng": -1.23456
  },
  "vpp_participation": {
    "id": "vpa_65ea3fb185c1541f247c251e",
    "provider_name": "Superpower",
    "programme_name": "Home Powerflex",
    "current_state": "ACTIVE",
    "telemetry_active": true,
    "control_active": true
  },
  "time_created": "2022-01-24T14:15:22Z",
  "reference_id": "ACC1234567890",
  "last_seen": "2022-03-22T11:12:21Z"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Path Parameters

​
device_id
string
required

Flatpeak Device ID

Response

This object represents a device or another asset of a compatible type.

​
id
string
required
read-only

Flatpeak Device ID.

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

"dev_63a6087272941ef077a8fd3e"

​
object
enum<string>
default:device
required
read-only

Object type, Device.

Available options:
device
Example:

"device"

​
live_mode
boolean
required

Set to true if the object exists in live mode, otherwise false.

​
controlled
boolean
required

Set to true when the device is under your control. This value can only be changed from true to false. To restore control, the customer must complete the Connect flow again.

​
properties
DeviceProperties · object
required

Physical characteristics of the device, grouped by subsystem. Include only the subsystems the device has: a battery-only unit omits pv, a solar-only unit omits battery.

​
consents
ConsentDevice · object
required
​
timezone
string
required

Device timezone.

Example:

"Europe/London"

​
geo_location
object
required

Geographic coordinates of the location.

​
vpp_participation
object
required

VPP participation associated with this device, if enrolled.

​
time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

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

​
reference_id
string
default:device
read-only

Customer account reference from your systems.

Example:

"ACC1234567890"

​
last_seen
string<date-time>

Timestamp of when the device has last queried the service.

Example:

"2022-03-22T11:12:21Z"