List non-cumulative data

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Retrieve a paginated list of non-cumulative (interval) consumption data from the Consumption model.

Note: This endpoint does not automatically filter by half-hourly data. To retrieve only half-hourly records, include the isHalfHourly=true query parameter.

Endpoint

GET /2.0/non-cumulative

Query Parameters

Pagination & Sorting

Parameter	Type	Default	Description
`limit`	number	`100`	Number of results per page
`page`	number	`1`	Page number (1-based)
`sort`	string	-	Sort field and direction. Format: `field:asc` or `field:desc` (e.g. `startTimestamp:desc`)

Filters

Any field listed in the Consumption object can be used as a query parameter to filter results.

Date range filters: Date fields support range operators using dot notation:

field.gte - Greater than or equal to
field.lte - Less than or equal to
field.gt - Greater than
field.lt - Less than

Example: startTimestamp.gte=2024-01-01&startTimestamp.lte=2024-01-31

Common filters:

Parameter	Type	Description
`accountId`	string	Filter by account (meter) ID
`entityId`	string	Filter by entity ID
`type`	string	Filter by utility type: `electricity`, `gas`, `water`, `waste`, `solar`, `heating`, `flow`, `cooling`, `temperature`, `other`
`unit`	string	Filter by unit (e.g. `kwh`, `m3`)
`source`	string	Filter by data source
`isHalfHourly`	boolean	Filter by half-hourly data (`true`) or non-half-hourly data (`false`)
`isEstimated`	boolean	Filter estimated data
`isGridData`	boolean	Filter grid data

Response

{
  "total": 1000,
  "limit": 100,
  "skip": 0,
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "value": 5.23,
      "startTimestamp": "2024-01-15T00:00:00.000Z",
      "endTimestamp": "2024-01-15T00:30:00.000Z",
      "type": "electricity",
      "unit": "kwh",
      "readType": "A",
      "isHalfHourly": true,
      "isEstimated": false,
      "isGridData": true,
      "accountId": "507f1f77bcf86cd799439012",
      "entityId": "507f1f77bcf86cd799439013",
      "createdAt": "2024-01-16T09:00:00.000Z",
      "updatedAt": "2024-01-16T09:00:00.000Z"
    }
  ]
}

Example Request

curl -X GET "https://api.etainabl.com/2.0/non-cumulative?accountId=507f1f77bcf86cd799439012&startTimestamp.gte=2024-01-01&startTimestamp.lte=2024-01-31&isHalfHourly=true&type=electricity&sort=startTimestamp:asc" \
  -H "x-api-key: YOUR_API_KEY"

Scope Required

read:consumptions