Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Meters

Create new meter reading

We strongly recommend using the batch create endpoint POST /meterreadings to create meter readings since it is more efficient and allows you to send more readings at once without consuming as much rate limit as this endpoint. <h3>Rate Limits</h3> <li>For Automated and IoT meter readings: 1 request / 10 seconds</li> <li>For Manual meter readings: 10 requests / 24 hours</li>

post/meters/{meterId}/readings

Path parameters

meterIdinteger required

ID of the meter

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Request body

readingValuenumber required

The reading value given by the meter.

readingDatestring nullable

Reading date when the meter was read. This date can be set in the past, but cannot go further than 3 days for IoT meters.

Example request

{
  "readingValue": 120,
  "readingDate": "2020-07-22T14:01:00Z"
}

Response

Successfully created reading

idstring required

Global ID of the reading. IoT meters will produce IDs with the format '{meterId}-{uuid}', while manual meters will produce numbered IDs.

createdAtstring

Reading creation or processing date.

readingDatestring nullable

Reading date when the meter was read. This date can be set in the past, but cannot go further than 3 days for IoT meters.

readingValuenumber required

The reading value given by the meter.

Example response

{
  "createdAt": "2022-01-01T00:00:00.000Z",
  "readingDate": "2020-07-22T14:01:00Z",
  "readingValue": 120
}