> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a device state > Retrieves the latest submitted device state. ## OpenAPI ````yaml energy-api/reference/flatpeak-api-spec-energy.json GET /devices/{device_id}/state openapi: 3.0.3 info: description: >- The Flatpeak Energy API connects energy hardware (batteries, EV chargers, vehicles, heat pumps, water heaters, solar and generators) to electricity prices, grid fees, and VPP programs. ## Create bearer token Obtain a bearer token from `POST /auth/tokens` using your `account_id` and `secret_key` via basic auth, then send it as `Authorization: Bearer ` on every request. ## Base URL `https://energy-api.flatpeak.com` ## Pagination List endpoints return a `list` envelope with `data`, `next_cursor`, and `url`. Page forward by passing `next_cursor` as `cursor` on the next request, until it is `null`. Cursors are opaque and bound to the endpoint and query parameters that issued them. ## Errors Every non-2xx response uses a standard error envelope with `object`, `type`, `code`, and `message`. Codes are machine-readable and safe to branch on. ## Money Monetary values are decimal numbers and are always paired with a `currency_code` (ISO 4217). Energy is expressed in kilowatt hours (kWh). ## Live vs test `live_mode` marks live or test data. version: 2027-01-01.busbar title: Flatpeak Energy API termsOfService: https://flatpeak.com/legal contact: name: Technical Support email: support@flatpeak.com url: https://flatpeak.com/contact license: name: Apache 2.0 url: https://flatpeak.com/legal servers: - url: https://energy-api.flatpeak.com security: - bearerAuth: [] tags: - name: Authentication description: >- Exchange your account credentials for a bearer token to authenticate API requests. - name: Connect description: >- Create and retrieve Connect sessions. Connect drives the user journeys for tariff connection, VPP enrollment, and [tariff error reporting](/energy-api/reference/connect/tariff/error-report). What happens in those journeys reaches your backend as [Connect webhooks](/energy-api/guides/platform/events). x-tariff-description: >- Create and retrieve Connect sessions. Connect drives the user journeys for tariff connection and [tariff error reporting](/energy-api/reference/connect/tariff/error-report). What happens in those journeys reaches your backend as [Connect webhooks](/energy-api/guides/platform/events). - name: Users description: Create, retrieve, update, delete, and list users. - name: Locations description: Create, retrieve, update, delete, and list locations. - name: Devices description: >- Create, retrieve, update, delete and list devices; submit and retrieve their state; read and write their shared settings. - name: Meters description: Submit meter records and check batch status. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Prices description: Retrieve and audit calculated energy prices. - name: Costs description: Calculate the monetary cost of imported or exported energy. - name: Optimizations description: >- Rank the connected tariff to find the best times to consume or export energy, as inputs to your own scheduling. - name: Dispatch description: >- Fetch the VPP operator's instructions for a device, and confirm what the device will deliver. - name: Events description: Retrieve and list account events. - name: VPP Enrollments description: Create, retrieve and list VPP enrollments, and unenroll a device. - name: VPP Programs description: List VPP programs available to devices. - name: VPP Events description: >- VPP events committed by VPP operators, with your fleet's share and its per-device allocation. You can take over the allocation while it is open. - name: Operator groups description: >- Read-only views of the device groups VPP operators define. You see the groups that touch your fleet, and only your own devices in them. - name: Zones description: >- Network areas VPP operators define that touch your fleet. Read-only. You see only your own devices in them. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /devices/{device_id}/state: parameters: - schema: type: string name: device_id in: path required: true description: Flatpeak Device ID. get: tags: - Devices summary: Retrieve a device state description: Retrieves the latest submitted device state. operationId: get-device-state parameters: [] responses: '200': $ref: '#/components/responses/DeviceState' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: responses: '401': description: '401 Unauthorized: authentication credentials are missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: '403 Forbidden: you do not have permission to access this resource.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '404 Not Found: the requested resource does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '429 Too Many Requests: the rate limit has been exceeded.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- 500 Internal Server Error: an unexpected error occurred. Safe to retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- 503 Service Unavailable: the service is temporarily down for maintenance. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' DeviceState: description: Device state response. content: application/json: schema: $ref: '#/components/schemas/DeviceState' schemas: DeviceState: type: object title: DeviceState description: The most recent operational state of a device, grouped by subsystem. properties: id: type: string example: dsr_6a284b7596d3f2b722544e70 description: Flatpeak device state record ID. pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ object: type: string example: device_state description: Object type. enum: - device_state default: device_state record_reference_id: type: string example: MET1234567890 description: >- Optional unique identifier for the telemetry record, used for idempotency and reconciliation. location_id: type: string example: loc_641b90b758fb8e6293716e40 description: Flatpeak Location ID of the device's location. pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ time_recorded: type: string example: '2026-02-01T10:30:00Z' description: Time the measurement was recorded, in RFC 3339 format. format: date-time battery: $ref: '#/components/schemas/DeviceStateBattery' vehicle: $ref: '#/components/schemas/DeviceStateVehicle' evse: $ref: '#/components/schemas/DeviceStateEvse' pv: $ref: '#/components/schemas/DeviceStatePv' time_created: type: string format: date-time example: '2026-02-01T10:33:00Z' description: Time when this object was created. In UTC. account_id: type: string example: acc_661677911f2197045e6cf1b1 description: Flatpeak Account ID. pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ required: - id - object - location_id - time_recorded - time_created - account_id Error: type: object description: Standard error envelope returned by every non-2xx response. required: - object - type - code - message properties: object: type: string enum: - error default: error description: Object type. type: type: string description: High-level error category. example: invalid_request code: type: string description: Machine-readable error code, safe to branch on. example: not_found message: type: string description: Human-readable description of the error. example: The requested resource could not be found. context: type: string description: Optional originating context, for example `api.price_get`. example: api.price_get live_mode: type: boolean description: Whether the error occurred against live or test data. time_created: type: string format: date-time description: Time the error was generated (RFC 3339). example: '2026-01-01T00:00:00Z' DeviceStateBattery: title: DeviceStateBattery type: object additionalProperties: false description: Operational state of a stationary battery. properties: state_of_charge_percent: type: number minimum: 0 maximum: 100 description: >- Usable state of charge, as a percentage from 0 to 100. Where the source distinguishes usable from nominal, report usable, so capacity locked out by temperature or battery management is excluded. example: 34.2 target_state_of_charge_percent: type: number minimum: 0 maximum: 100 description: >- State of charge the battery is working towards, as a percentage from 0 to 100, as reported by the device. Not a shared setting. example: 80 power_kw: type: number description: >- Current battery power in kilowatts. Positive values indicate charging, negative values indicate discharging. example: -3.4 energy_remaining_kwh: type: number minimum: 0 description: Estimated usable energy available, in kilowatt-hours. example: 8.3 temperature_c: type: number description: >- Current battery pack temperature, in degrees Celsius. Where the source reports multiple module or cell temperatures, report the pack-level figure. example: 18.5 backup_reserve_percent: type: number minimum: 0 maximum: 100 description: >- Percentage of capacity reserved for backup and unavailable for dispatch. Reported value: the desired value is set through [device settings](/energy-api/reference/device-settings/update). example: 20 strategy: type: string enum: - SELF_POWER - SAVINGS description: >- Strategy the battery is operating under: `SELF_POWER` maximizes use of self-generated energy, `SAVINGS` charges when prices are low and discharges when high. Reported value; the desired value is set through device settings. example: SELF_POWER storm_mode_enabled: type: boolean description: >- Whether storm mode is enabled: the battery holds or increases charge ahead of severe weather. Reported value; the desired value is set through device settings. example: true storm_mode_active: type: boolean example: false description: >- `true` while the battery holds or builds charge for a forecast storm. Reported by the device. Distinct from the `storm_mode_enabled` setting, which says whether the feature is on. Energy held for a storm is not available for dispatch. export_rule: type: string enum: - BATTERY_OK - PV_ONLY - NEVER example: BATTERY_OK description: >- Export rule applied by the device; reported value of the `export_rule` setting: `BATTERY_OK`, `PV_ONLY` or `NEVER`. charge_from_grid_enabled: type: boolean example: true description: >- Whether the battery may charge from the grid; reported value of the `charge_from_grid_enabled` setting. grid_status: type: string enum: - ON_GRID - ISLANDED - UNKNOWN example: ON_GRID description: >- An islanded device is not dispatched; affected intervals are recorded as declined, not as a shortfall. | Value | Meaning | | :--- | :--- | | `ON_GRID` | Connected | | `ISLANDED` | On backup, disconnected | | `UNKNOWN` | Not reported | DeviceStateVehicle: title: DeviceStateVehicle type: object additionalProperties: false description: Operational state of an electric vehicle. properties: state_of_charge_percent: type: number minimum: 0 maximum: 100 description: >- Usable state of charge of the traction battery, as a percentage from 0 to 100. Where the source distinguishes usable from nominal, report usable. example: 62 charge_limit_percent: type: number minimum: 0 maximum: 100 description: Charge limit set on the vehicle, as a percentage from 0 to 100. example: 80 energy_remaining_kwh: type: number minimum: 0 description: >- Estimated usable energy available in the traction battery, in kilowatt-hours. example: 39.7 plugged_in: type: boolean description: Whether the vehicle is connected to a charge point. example: true charging_state: type: string enum: - CHARGING - STOPPED - COMPLETE - DISCONNECTED example: CHARGING description: |- | Value | Meaning | | :--- | :--- | | `CHARGING` | Current flows | | `STOPPED` | Plugged in, paused | | `COMPLETE` | Plugged in, at charge limit | | `DISCONNECTED` | Nothing connected | time_departure: type: string format: date-time description: >- Expected departure time set on the vehicle, RFC 3339 in UTC; reported value of the `time_departure` setting. Smart charging plans against this deadline. example: '2026-02-01T07:30:00Z' range_km: type: number minimum: 0 description: >- Estimated remaining range in kilometers, based on current consumption. Convert from miles at ingest. example: 180 max_charging_power_kw: type: number minimum: 0 nullable: true example: 7.4 description: >- Charging power ceiling applied by the vehicle, in kW; reported value of the `max_charging_power_kw` setting. `null` when no ceiling is set. DeviceStateEvse: title: DeviceStateEvse type: object additionalProperties: false description: Operational state of an EV charge point. properties: plugged_in: type: boolean description: Whether a vehicle is connected to the charge point. example: true charging_state: type: string enum: - CHARGING - STOPPED - COMPLETE - DISCONNECTED example: CHARGING description: |- | Value | Meaning | | :--- | :--- | | `CHARGING` | Current flows | | `STOPPED` | Plugged in, paused | | `COMPLETE` | Plugged in, at charge limit | | `DISCONNECTED` | Nothing connected | power_kw: type: number description: >- Current power at the connector, in kilowatts. Positive values indicate delivery to the vehicle, negative values indicate the vehicle exporting through the charge point. example: 7.2 max_charging_power_kw: type: number minimum: 0 nullable: true example: 7.4 description: >- Charging power ceiling applied by the charger, in kW; reported value of the `max_charging_power_kw` setting. `null` when no ceiling is set. DeviceStatePv: title: DeviceStatePv type: object additionalProperties: false description: Operational state of solar generation. properties: power_kw: type: number minimum: 0 description: Current generation output, in kilowatts. example: 4.2 securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer token obtained from POST /auth/tokens. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.