Skip to main content
POST
/
v1
/
meter
/
create
Create meter
curl --request POST \
  --url https://api.voltview.co.uk/v1/meter/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "siteId": 123,
  "mpxn": "<string>"
}
'
{
  "id": "<string>",
  "siteId": "<string>",
  "mpxn": "<string>",
  "meterSerialNumber": "<string>",
  "supplier": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

VoltView API key

Body

application/json
​
siteId
integer
required

ID of the site to add the meter to

​
mpxn
string
required

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

​
utilityType
enum<string>
required

Type of utility

Available options:
ELECTRICITY,
GAS,
BMS

Response

Meter created successfully

​
id
string

Meter identifier

​
siteId
string

Associated site identifier

​
mpxn
string

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

​
utilityType
enum<string>

Type of utility

Available options:
ELECTRICITY,
GAS,
BMS
​
meterSerialNumber
string

Meter serial number

​
supplier
string

Energy supplier name

​
status
enum<string>

Meter status

Available options:
ACTIVE,
INACTIVE
​
createdAt
string<date-time>

Creation timestamp