> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # List device deliveries > Returns the device's delivery per VPP event interval within the window: committed power and energy, delivered energy, coverage and fulfillment. Delivery is measured from meter records; intervals no meter records cover are `UNREPORTED`. An interval in which the device was given no share is `NOT_COMMITTED`. ## OpenAPI ````yaml energy-api/reference/flatpeak-api-spec-energy.json GET /devices/{device_id}/deliveries 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}/deliveries: parameters: - schema: type: string name: device_id in: path required: true description: Flatpeak Device ID. get: tags: - Devices summary: List device deliveries description: >- Returns the device's delivery per VPP event interval within the window: committed power and energy, delivered energy, coverage and fulfillment. Delivery is measured from meter records; intervals no meter records cover are `UNREPORTED`. An interval in which the device was given no share is `NOT_COMMITTED`. operationId: list-device-deliveries parameters: - schema: type: string name: vpp_event_id in: query required: false description: Only the commitment made under this VPP event. - schema: type: string format: date-time name: start_time in: query required: true description: Start time, in UTC. - schema: type: string format: date-time name: end_time in: query required: true description: End time, in UTC. - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/VppEventDeliveryList' '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: parameters: limit: name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 30 description: Maximum number of objects to return per page, default 30. Maximum 100. cursor: name: cursor in: query required: false schema: type: string description: >- Pagination cursor. Pass `next_cursor` from the previous response unchanged; omit for the first page. A cursor used with different parameters returns `400 cursor_invalid`. 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' VppEventDeliveryList: description: VPP event delivery list response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ListResponse' - type: object properties: data: type: array description: The page of results. items: $ref: '#/components/schemas/VppEventDelivery' example: object: list url: /devices/dev_63a6087272941ef077a8fd3e/deliveries next_cursor: null data: - object: vpp_event_delivery device_id: dev_63a6087272941ef077a8fd3e vpp_event_id: vpe_7d2a4c6e9b1f3a5c8e0d2f4b program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c start_time: '2026-08-04T20:00:00Z' end_time: '2026-08-04T21:00:00Z' committed_power_kw: -4.3 committed_energy_kwh: -4.3 delivered_energy_kwh: -4.3 coverage: 1 fulfillment: 1 status: FULL time_reported: '2026-08-04T22:06:12Z' commitment_confidence: 0.91 - object: vpp_event_delivery device_id: dev_63a6087272941ef077a8fd3e vpp_event_id: vpe_7d2a4c6e9b1f3a5c8e0d2f4b program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c start_time: '2026-08-04T21:00:00Z' end_time: '2026-08-04T22:00:00Z' committed_power_kw: -4.3 committed_energy_kwh: -4.3 delivered_energy_kwh: -3.6 coverage: 1 fulfillment: 0.84 status: PARTIAL time_reported: '2026-08-04T22:06:12Z' commitment_confidence: 0.91 schemas: ListResponse: type: object description: Standard envelope for paginated list endpoints. required: - object - url - next_cursor - data properties: object: type: string enum: - list default: list description: Object type. url: type: string description: URL for this list. example: /users next_cursor: type: string nullable: true description: >- Opaque cursor for the next page. Pass it as `cursor` on the next request. `null` on the last page. Do not stop on a short or empty `data` array. example: djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx data: type: array items: {} description: The page of results. VppEventDelivery: type: object title: VppEventDelivery description: >- One VPP event window for one device, and the device's delivery against it, measured from meter records. Fulfillment and rewards derive from these rows. A device that is in the event but was given no share for a window has a row with `status` `NOT_COMMITTED`. additionalProperties: false required: - object - device_id - vpp_event_id - program_id - start_time - end_time - committed_power_kw - committed_energy_kwh - delivered_energy_kwh - coverage - fulfillment - status - time_reported - commitment_confidence properties: object: type: string description: Object type, `vpp_event_delivery`. example: vpp_event_delivery enum: - vpp_event_delivery device_id: type: string description: Flatpeak Device ID this delivery row belongs to. example: dev_63a6087272941ef077a8fd3e vpp_event_id: type: string description: Flatpeak VPP event ID the commitment was made under. example: vpe_7d2a4c6e9b1f3a5c8e0d2f4b program_id: type: string description: Flatpeak Program ID the commitment was made under. example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c start_time: type: string description: Time when the window starts, in UTC. format: date-time example: '2026-08-04T20:14:00Z' end_time: type: string description: Time when the window ends, in UTC. format: date-time example: '2026-08-04T22:00:00Z' committed_power_kw: type: number description: >- Committed power for the window, in kilowatts. Positive values indicate import, negative values indicate export. example: -4.3 committed_energy_kwh: type: number description: >- Energy the commitment implies over the window, in kWh, signed like power. example: -7.6 delivered_energy_kwh: type: number description: >- Energy delivered within the window, in kWh, signed like power: the metered energy of the intervals that the device's meter records cover in full, to three decimals. It rises as late records arrive, and rewards are priced from it. `null` when no meter records cover the window. nullable: true example: -7.6 coverage: type: number nullable: true minimum: 0 maximum: 1 description: >- Share of the window covered by meter records, from 0 to 1. `null` until a record covers any of it. Intervals without full coverage are left out of `delivered_energy_kwh` until late records arrive. example: 1 fulfillment: type: number description: >- Share of the committed energy delivered, from 0 to 1, energy weighted: 1 means the full window at the committed power. Measured from meter records. `null` when none cover the window. minimum: 0 maximum: 1 nullable: true example: 1 status: type: string enum: - FULL - PARTIAL - ZERO - UNREPORTED - OPTED_OUT - NOT_COMMITTED description: >- | Value | Meaning | | :--- | :--- | | `FULL` | Fulfillment 1 | | `PARTIAL` | Fulfillment between 0 and 1 | | `ZERO` | Metered, nothing delivered | | `UNREPORTED` | No meter records cover the window | | `OPTED_OUT` | User skipped it | | `NOT_COMMITTED` | In the event, but given no share for the window | example: FULL time_reported: type: string description: >- Time the last meter record covering the window was received, in UTC. `null` when unreported. format: date-time nullable: true example: '2026-08-04T16:05:04Z' commitment_confidence: type: number minimum: 0 maximum: 1 nullable: true example: 0.92 description: >- Likelihood that the device meets its commitment, from 0 to 1. Derived from the device's confirmations and delivery history. Set when the commitment is made. 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' 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.