Meters

List meter reads for a meter with optional date range filtering and pagination.

API key: requires the meters:read scope.

get/v1/meters/{meterId}/reads

Request

  • Base URL
    https://api.voltview.co.uk
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

meterIdstring required

UUID of the meter

Query parameters

fromDatestring date-time

Start date filter (ISO date string)

toDatestring date-time

End date filter (ISO date string)

registerCode'TOTAL' | 'DAY' | 'NIGHT' | 'PEAK' | 'OFF_PEAK'

Filter by register code

limitinteger

Number of records to return (max 1000)

offsetinteger

Offset for pagination

Response

Meter reads retrieved successfully

idstring

Meter read identifier

meterIdstring

Associated meter identifier

readValuenumber

Meter reading value

readDatestring date-time

Date of the reading

readType'ACTUAL' | 'ESTIMATED' | 'CUSTOMER'

Type of reading

registerCode'TOTAL' | 'DAY' | 'NIGHT' | 'PEAK' | 'OFF_PEAK'

Register code

source'MANUAL' | 'INVOICE' | 'SMART_METER' | 'SUPPLIER_API'

Source of the reading

notesstring

Additional notes

createdAtstring date-time

Creation timestamp

Changes

    • info

      the endpoint scheme security apiKeyAuth was added to the API

    • info

      the endpoint scheme security sessionJwt was added to the API

    • breaking

      the response property / became optional for the status

    4 more changes in this revision