Meters

Retrieve all meters associated with a specific site.

Scoped API keys require meters:read and effective site access.

API key: requires the meters:read scope.

get/v1/sites/{siteId}/meters

Request

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

Path parameters

siteIdstring required

Site identifier

Response

Meters retrieved successfully

idstring

Meter identifier

siteIdstring

Associated site identifier

mpxnstring

MPAN (13 digits for electricity) or MPRN (6-10 digits for gas)

utilityType'ELECTRICITY' | 'GAS' | 'BMS'

Type of utility

meterSerialNumberstring

Meter serial number

supplierstring

Energy supplier name

status'ACTIVE' | 'INACTIVE'

Meter status

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

    3 more changes in this revision