Skip to main content
GET
/
v1
/
meters
/
{meterId}
/
reads
Get meter reads
curl --request GET \
  --url https://api.voltview.co.uk/v1/meters/{meterId}/reads \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "meterId": "<string>",
    "readValue": 123,
    "readDate": "2023-11-07T05:31:56Z",
    "notes": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

VoltView API key

Path Parameters

​
meterId
string
required

UUID of the meter

Query Parameters

​
fromDate
string<date-time>

Start date filter (ISO date string)

​
toDate
string<date-time>

End date filter (ISO date string)

​
registerCode
enum<string>

Filter by register code

Available options:
TOTAL,
DAY,
NIGHT,
PEAK,
OFF_PEAK
​
limit
integer
default:100

Number of records to return (max 1000)

Required range: x <= 1000
​
offset
integer
default:0

Offset for pagination

Response

Meter reads retrieved successfully

​
id
string

Meter read identifier

​
meterId
string

Associated meter identifier

​
readValue
number

Meter reading value

​
readDate
string<date-time>

Date of the reading

​
readType
enum<string>

Type of reading

Available options:
ACTUAL,
ESTIMATED,
CUSTOMER
​
registerCode
enum<string>

Register code

Available options:
TOTAL,
DAY,
NIGHT,
PEAK,
OFF_PEAK
​
source
enum<string>

Source of the reading

Available options:
MANUAL,
INVOICE,
SMART_METER,
SUPPLIER_API
​
notes
string

Additional notes

​
createdAt
string<date-time>

Creation timestamp