> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # List device meter records > Returns the device's meter records over a window of up to 90 days, at their original intervals or aggregated with `aggregate_by`. Positive is import, negative is export. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json GET /devices/{device_id}/meter-records openapi: 3.0.3 info: description: >- The Flatpeak Fleet API. VPP operators use it to enroll, dispatch and settle OEM device fleets. ## Authentication Exchange your `account_id` and `secret_key` for a bearer token at `POST /auth/tokens` with basic auth. Send it as `Authorization: Bearer ` on every request. ## Base URL `https://fleet-api.flatpeak.com` ## Pagination Lists return `data`, `next_cursor` and `url`. Pass `next_cursor` as `cursor` until it is `null`. A cursor is opaque and bound to the endpoint and query parameters that issued it. ## Errors Every non-2xx response carries `object`, `type`, `code` and `message`. Branch on `code`. ## Money and energy Money is a decimal number paired with a `currency_code` (ISO 4217). Power is in kW and energy in kWh. Positive is import, negative is export. ## Live and test `live_mode` marks live or test data. version: 2027-01-01.busbar title: Flatpeak Fleet 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://fleet-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 for onboarding customers through your own app. - name: OEMs description: List and retrieve the OEMs whose devices your fleet can reach. - name: Devices description: >- Retrieve, list and update the devices connected to your account, and read their consent history and shared settings. - name: Locations description: >- Read the location a device sits behind: its timezone, currency, metering and your devices there. - name: Dispatch description: Submit plans to devices on managed tariffs and read the dispatch timeline. - name: Telemetry description: Read device state, device meter records and location meter records. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Events description: Retrieve and list account events. - name: VPP Programs description: >- Define and manage VPP programs: the commercial terms devices enroll under, and their live state. - name: Groups description: >- Named collections of devices for bulk dispatch and aggregated reads. OEMs see them read-only as [groups](/energy-api/reference/groups/list) on the Energy API. - name: Zones description: >- Network areas resolved to devices by Flatpeak, for locational eligibility and grouping without handling addresses. - name: Exports description: >- Package settlement evidence, consent records and enrollment registers as downloadable files. - name: Rewards description: >- The reward ledger: entries accrue from delivery, you approve them, pay the customers and mark them paid. - name: VPP Enrollments description: Track and act on device enrollments across your programs. - name: VPP Events description: >- Commit market activations: create an event for a group, then read its state and its devices' results. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /devices/{device_id}/meter-records: parameters: - schema: type: string name: device_id in: path required: true description: Flatpeak Device ID. get: tags: - Telemetry summary: List device meter records description: >- Returns the device's meter records over a window of up to 90 days, at their original intervals or aggregated with `aggregate_by`. Positive is import, negative is export. operationId: list-device-meter-records parameters: - name: cursor in: query required: false schema: type: string example: djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx 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`. - name: limit in: query required: false schema: type: integer example: 100 minimum: 1 maximum: 25000 default: 100 description: >- Records per page. Default 100, maximum 25000: a full year of half-hourly records. - name: aggregate_by in: query required: false schema: type: string example: NON_FIXED enum: - NON_FIXED - HALF_HOUR - HOUR - DAY - WEEK - MONTH description: >- Aggregation period: `NON_FIXED` (default, original intervals), `HALF_HOUR`, `HOUR`, `DAY`, `WEEK` or `MONTH`. - name: flow_basis in: query required: false schema: type: string enum: - NET - GROSS default: NET example: NET description: >- `NET` (default): one record per interval, import netted against export. `GROSS`: import and export as separate records, distinguished by sign. - name: order_by in: query required: false schema: type: string example: NEWEST description: >- Ordering of returned data. `NEWEST` (default) returns the most recent records first. `OLDEST` returns records in chronological order. - name: start_time in: query required: false schema: type: string example: '2026-11-07T05:31:56Z' format: date-time description: >- Start of the data window, RFC 3339, for example `2026-06-15T09:00:00Z` or `2026-06-15T08:00:00+01:00`. If the offsets of `start_time` and `end_time` differ, `end_time` wins. - name: end_time in: query required: false schema: type: string example: '2026-11-07T05:31:56Z' format: date-time description: >- End of the data window, RFC 3339, for example `2026-06-15T13:00:00Z` or `2026-06-15T12:00:00+01:00`. If the offsets of `start_time` and `end_time` differ, `end_time` wins. Maximum range: 90 days. responses: '200': $ref: '#/components/responses/DeviceMeterRecords' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: responses: '400': description: >- 400 Bad Request: the request was malformed or a required field is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' '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' '422': description: >- 422 Unprocessable Entity: the request is well-formed but cannot be processed, for example missing required data. 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' DeviceMeterRecords: description: Device meter records response. content: application/json: schema: $ref: '#/components/schemas/DeviceMeterRecords' example: object: meter_records device_id: dev_63a6087272941ef077a8fd3e oem_id: oem_6a3a8dada72cd0a249ff9528 count: 2 next_cursor: null data: - start_time: '2026-07-09T02:00:00Z' end_time: '2026-07-09T02:30:00Z' energy_kwh: 2.15 - start_time: '2026-07-09T02:30:00Z' end_time: '2026-07-09T03:00:00Z' energy_kwh: 2.15 schemas: DeviceMeterRecords: type: object additionalProperties: false required: - object - device_id - oem_id - count - next_cursor - data properties: object: type: string description: Object type, `meter_records`. example: meter_records enum: - meter_records device_id: type: string description: Flatpeak Device ID the records belong to. example: dev_63a6087272941ef077a8fd3e oem_id: type: string pattern: ^oem_[A-Za-z0-9]+$ example: oem_6a3a8dada72cd0a249ff9528 description: 'Flatpeak OEM ID: the OEM that connects the device.' count: type: integer minimum: 0 description: >- Total number of records in the requested window, across every page. It stays the same from page to page, and `data` holds only the current page. example: 2 next_cursor: type: string nullable: true description: >- Cursor for the next page. Pass it as `cursor`. `null` on the last page. Page until it is `null`, even if `data` is short or empty. example: djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx data: type: array description: The page of meter records, one per interval. items: $ref: '#/components/schemas/MeterRecord' title: DeviceMeterRecords description: A device's meter records over the requested window, one page at a time. 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: access_denied 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' MeterRecord: type: object title: MeterRecord additionalProperties: false description: Energy transferred over one interval, measured by a meter. required: - start_time - end_time - energy_kwh properties: start_time: type: string format: date-time description: Interval start, in UTC. example: '2026-07-09T02:00:00Z' end_time: type: string format: date-time description: Interval end, in UTC. example: '2026-07-09T02:30:00Z' energy_kwh: type: number example: 2.15 description: >- Energy transferred during the interval, in kWh. Positive is import, negative is export. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Authenticate with the `bearer_token` obtained from the [authentication](/fleet-api/reference/authentication) endpoint. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.