Add Custom Meter
curl --request POST \
--url https://realtime.replace-me.example.com/custommeters/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"utilityAccountNumber": "123",
"accountId": 58895,
"submeterAccountId": null,
"meterNumber": "12345",
"type": "realtime",
"multiplier": 1,
"readingsPerHour": 4,
"name": "Meter: 12345 - Postman Generated Test",
"timezone": "UTC",
"displayTimezone": "UTC",
"commodity": "electric",
"meterProvider": "OBVIUS_METER",
"sourceCategory": "CONSUMPTION",
"productionType": null,
"energyUnit": "KW",
"isCumulative": false,
"additionalSettings": {
"password": "********",
"serialNumber": "001ABCDE",
"device": "2",
"readingColumns": "8",
"timestampColumn": 1
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
utilityAccountNumber: '123',
accountId: 58895,
submeterAccountId: null,
meterNumber: '12345',
type: 'realtime',
multiplier: 1,
readingsPerHour: 4,
name: 'Meter: 12345 - Postman Generated Test',
timezone: 'UTC',
displayTimezone: 'UTC',
commodity: 'electric',
meterProvider: 'OBVIUS_METER',
sourceCategory: 'CONSUMPTION',
productionType: null,
energyUnit: 'KW',
isCumulative: false,
additionalSettings: {
password: '********',
serialNumber: '001ABCDE',
device: '2',
readingColumns: '8',
timestampColumn: 1
}
})
};
fetch('https://realtime.replace-me.example.com/custommeters/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://realtime.replace-me.example.com/custommeters/"
payload = {
"utilityAccountNumber": "123",
"accountId": 58895,
"submeterAccountId": None,
"meterNumber": "12345",
"type": "realtime",
"multiplier": 1,
"readingsPerHour": 4,
"name": "Meter: 12345 - Postman Generated Test",
"timezone": "UTC",
"displayTimezone": "UTC",
"commodity": "electric",
"meterProvider": "OBVIUS_METER",
"sourceCategory": "CONSUMPTION",
"productionType": None,
"energyUnit": "KW",
"isCumulative": False,
"additionalSettings": {
"password": "********",
"serialNumber": "001ABCDE",
"device": "2",
"readingColumns": "8",
"timestampColumn": 1
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": 12405,
"utilityAccountNumber": "123",
"accountId": 58895,
"meterNumber": "12345",
"type": "realtime",
"multiplier": 1,
"readingsPerHour": 4,
"name": "Meter: 12345 - Postman Generated Test",
"timezone": "UTC",
"displayTimezone": "UTC",
"commodity": "electric",
"meterProvider": "OBVIUS_METER",
"sourceCategory": "CONSUMPTION",
"isCumulative": false,
"additionalSettings": {
"password": "********",
"serialNumber": "001ABCDE",
"device": "2",
"readingColumns": "8",
"timestampColumn": 1
},
"virtualMeter": false,
"cumulative": false,
"energyUnitCode": "KW",
"energyUnit": "kW"
}RealTime API - Custom Meter
Add Custom Meter
A POST request is used to add a custom meter.
POST
/
custommeters
/
Add Custom Meter
curl --request POST \
--url https://realtime.replace-me.example.com/custommeters/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"utilityAccountNumber": "123",
"accountId": 58895,
"submeterAccountId": null,
"meterNumber": "12345",
"type": "realtime",
"multiplier": 1,
"readingsPerHour": 4,
"name": "Meter: 12345 - Postman Generated Test",
"timezone": "UTC",
"displayTimezone": "UTC",
"commodity": "electric",
"meterProvider": "OBVIUS_METER",
"sourceCategory": "CONSUMPTION",
"productionType": null,
"energyUnit": "KW",
"isCumulative": false,
"additionalSettings": {
"password": "********",
"serialNumber": "001ABCDE",
"device": "2",
"readingColumns": "8",
"timestampColumn": 1
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
utilityAccountNumber: '123',
accountId: 58895,
submeterAccountId: null,
meterNumber: '12345',
type: 'realtime',
multiplier: 1,
readingsPerHour: 4,
name: 'Meter: 12345 - Postman Generated Test',
timezone: 'UTC',
displayTimezone: 'UTC',
commodity: 'electric',
meterProvider: 'OBVIUS_METER',
sourceCategory: 'CONSUMPTION',
productionType: null,
energyUnit: 'KW',
isCumulative: false,
additionalSettings: {
password: '********',
serialNumber: '001ABCDE',
device: '2',
readingColumns: '8',
timestampColumn: 1
}
})
};
fetch('https://realtime.replace-me.example.com/custommeters/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://realtime.replace-me.example.com/custommeters/"
payload = {
"utilityAccountNumber": "123",
"accountId": 58895,
"submeterAccountId": None,
"meterNumber": "12345",
"type": "realtime",
"multiplier": 1,
"readingsPerHour": 4,
"name": "Meter: 12345 - Postman Generated Test",
"timezone": "UTC",
"displayTimezone": "UTC",
"commodity": "electric",
"meterProvider": "OBVIUS_METER",
"sourceCategory": "CONSUMPTION",
"productionType": None,
"energyUnit": "KW",
"isCumulative": False,
"additionalSettings": {
"password": "********",
"serialNumber": "001ABCDE",
"device": "2",
"readingColumns": "8",
"timestampColumn": 1
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": 12405,
"utilityAccountNumber": "123",
"accountId": 58895,
"meterNumber": "12345",
"type": "realtime",
"multiplier": 1,
"readingsPerHour": 4,
"name": "Meter: 12345 - Postman Generated Test",
"timezone": "UTC",
"displayTimezone": "UTC",
"commodity": "electric",
"meterProvider": "OBVIUS_METER",
"sourceCategory": "CONSUMPTION",
"isCumulative": false,
"additionalSettings": {
"password": "********",
"serialNumber": "001ABCDE",
"device": "2",
"readingColumns": "8",
"timestampColumn": 1
},
"virtualMeter": false,
"cumulative": false,
"energyUnitCode": "KW",
"energyUnit": "kW"
}Authorizations
Token returned by POST /authenticate. Expires after 60 minutes of inactivity.
Body
application/json
Show child attributes
Show child attributes
Response
Created
Show child attributes
Show child attributes

