v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Usage

Retrieve usage data

Retrieve the usage data for a subscription. Usage is the electricity consumed from the grid, or fed into the grid for feed-in subscriptions. Values are positive magnitudes for both directions; the direction comes from the plan. Results depend on the meter type.

Smart meters: Usage data becomes available from 4pm on the following day. Metering Service Providers (MSB) might share preliminary values until replaced by final values up to the 8th working day of the following month. Data is available as soon as provided by the responsible MSB. Delays or missing data may occur.

Analog meters: Data is based on meter readings by customers and MSBs and available on a monthly level. In the absence of metering readings, Nomos creates a preliminary estimation at the end of each month. Subsequent meter readings take precedence over existing estimates and trigger invoice corrections if applicable.

get/subscriptions/{id}/usage

Path parameters

idstring required
Example:sub_ig1f5x45789r3ax7dlfff4q4

Query parameters

resolution'auto' | '15min' | 'hour' | 'day' | 'week' | 'month'

The resolution of the consumption. 'auto' will choose a good resolution based on the start and end date.

Example:auto

The resolution of the consumption. 'auto' will choose a good resolution based on the start and end date.

startstring

The start date of the interval (inclusive). Defaults depend on the meter type.
Smart meters: yesterday start of day (00:00:00) in the customers's timezone. Analog meters: subscription start date or 12 months ago, whichever is later.

Example:2025-03-30

The start date of the interval (inclusive). Defaults depend on the meter type.
Smart meters: yesterday start of day (00:00:00) in the customers's timezone. Analog meters: subscription start date or 12 months ago, whichever is later.

endstring

The end date of the interval (exclusive). Defaults depend on the meter type. Smart meters: today start of day (00:00:00) in the customers's timezone. Analog meters: latest available reading date.

Example:2025-03-31

The end date of the interval (exclusive). Defaults depend on the meter type. Smart meters: today start of day (00:00:00) in the customers's timezone. Analog meters: latest available reading date.

Response

Retrieve the subscription usage

object'usage' required
meter_type'analog' | 'smart' required

The meter type. Smart meters record consumption data in 15min intervals, analog meter readings only get reported periodically by the metering operator or the customer.

resolution'15min' | 'hour' | 'day' | 'week' | 'month' required

The resolution of the consumption. An optimal resolution will be chosen based on the start and end date if no resolution is provided in the query params.

Example response

{
  "meter_type": "smart",
  "resolution": "15min",
  "data": [
    {
      "start": "2025-03-31T22:00:00.000Z",
      "usage": 0.2,
      "type": "final"
    },
    {
      "start": "2025-03-31T22:15:00.000Z",
      "usage": 0.15,
      "type": "final"
    },
    {
      "start": "2025-03-31T22:30:00.000Z",
      "usage": 0.18,
      "type": "final"
    },
    {
      "start": "2025-03-31T22:45:00.000Z",
      "usage": 0.12,
      "type": "final"
    },
    {
      "start": "2025-03-31T23:00:00.000Z",
      "usage": 0.1,
      "type": "final"
    },
    {
      "start": "2025-03-31T23:15:00.000Z",
      "usage": 0.08,
      "type": "final"
    },
    {
      "start": "2025-03-31T23:30:00.000Z",
      "usage": 0.09,
      "type": "final"
    },
    {
      "start": "2025-03-31T23:45:00.000Z",
      "usage": 0.11,
      "type": "final"
    },
    {
      "start": "2025-04-01T00:00:00.000Z",
      "usage": 0.13,
      "type": "final"
    },
    {
      "start": "2025-04-01T00:15:00.000Z",
      "usage": 0.14,
      "type": "final"
    },
    {
      "start": "2025-04-01T00:30:00.000Z",
      "usage": 0.16,
      "type": "final"
    },
    {
      "start": "2025-04-01T00:45:00.000Z",
      "usage": 0.17,
      "type": "final"
    },
    {
      "start": "2025-04-01T01:00:00.000Z",
      "usage": 0.19,
      "type": "final"
    },
    {
      "start": "2025-04-01T01:15:00.000Z",
      "usage": 0.21,
      "type": "final"
    },
    {
      "start": "2025-04-01T01:30:00.000Z",
      "usage": 0.23,
      "type": "final"
    },
    {
      "start": "2025-04-01T01:45:00.000Z",
      "usage": 0.25,
      "type": "final"
    },
    {
      "start": "2025-04-01T02:00:00.000Z",
      "usage": 0.28,
      "type": "final"
    },
    {
      "start": "2025-04-01T02:15:00.000Z",
      "usage": 0.31,
      "type": "final"
    },
    {
      "start": "2025-04-01T02:30:00.000Z",
      "usage": 0.34,
      "type": "final"
    },
    {
      "start": "2025-04-01T02:45:00.000Z",
      "usage": 0.37,
      "type": "final"
    },
    {
      "start": "2025-04-01T03:00:00.000Z",
      "usage": 0.41,
      "type": "final"
    },
    {
      "start": "2025-04-01T03:15:00.000Z",
      "usage": 0.45,
      "type": "final"
    },
    {
      "start": "2025-04-01T03:30:00.000Z",
      "usage": 0.49,
      "type": "final"
    },
    {
      "start": "2025-04-01T03:45:00.000Z",
      "usage": 0.53,
      "type": "final"
    },
    {
      "start": "2025-04-01T04:00:00.000Z",
      "usage": 0.58,
      "type": "final"
    },
    {
      "start": "2025-04-01T04:15:00.000Z",
      "usage": 0.63,
      "type": "final"
    },
    {
      "start": "2025-04-01T04:30:00.000Z",
      "usage": 0.68,
      "type": "final"
    },
    {
      "start": "2025-04-01T04:45:00.000Z",
      "usage": 0.73,
      "type": "final"
    },
    {
      "start": "2025-04-01T05:00:00.000Z",
      "usage": 0.79,
      "type": "final"
    },
    {
      "start": "2025-04-01T05:15:00.000Z",
      "usage": 0.85,
      "type": "final"
    },
    {
      "start": "2025-04-01T05:30:00.000Z",
      "usage": 0.91,
      "type": "final"
    },
    {
      "start": "2025-04-01T05:45:00.000Z",
      "usage": 0.97,
      "type": "final"
    },
    {
      "start": "2025-04-01T06:00:00.000Z",
      "usage": 1.04,
      "type": "final"
    },
    {
      "start": "2025-04-01T06:15:00.000Z",
      "usage": 1.11,
      "type": "final"
    },
    {
      "start": "2025-04-01T06:30:00.000Z",
      "usage": 1.18,
      "type": "final"
    },
    {
      "start": "2025-04-01T06:45:00.000Z",
      "usage": 1.25,
      "type": "final"
    },
    {
      "start": "2025-04-01T07:00:00.000Z",
      "usage": 1.32,
      "type": "final"
    },
    {
      "start": "2025-04-01T07:15:00.000Z",
      "usage": 1.39,
      "type": "final"
    },
    {
      "start": "2025-04-01T07:30:00.000Z",
      "usage": 1.46,
      "type": "final"
    },
    {
      "start": "2025-04-01T07:45:00.000Z",
      "usage": 1.53,
      "type": "final"
    },
    {
      "start": "2025-04-01T08:00:00.000Z",
      "usage": 1.6,
      "type": "final"
    },
    {
      "start": "2025-04-01T08:15:00.000Z",
      "usage": 1.67,
      "type": "final"
    },
    {
      "start": "2025-04-01T08:30:00.000Z",
      "usage": 1.74,
      "type": "final"
    },
    {
      "start": "2025-04-01T08:45:00.000Z",
      "usage": 1.81,
      "type": "final"
    },
    {
      "start": "2025-04-01T09:00:00.000Z",
      "usage": 1.88,
      "type": "final"
    },
    {
      "start": "2025-04-01T09:15:00.000Z",
      "usage": 1.95,
      "type": "final"
    },
    {
      "start": "2025-04-01T09:30:00.000Z",
      "usage": 2.02,
      "type": "final"
    },
    {
      "start": "2025-04-01T09:45:00.000Z",
      "usage": 2.09,
      "type": "final"
    },
    {
      "start": "2025-04-01T10:00:00.000Z",
      "usage": 2.16,
      "type": "final"
    },
    {
      "start": "2025-04-01T10:15:00.000Z",
      "usage": 2.23,
      "type": "final"
    },
    {
      "start": "2025-04-01T10:30:00.000Z",
      "usage": 2.3,
      "type": "final"
    },
    {
      "start": "2025-04-01T10:45:00.000Z",
      "usage": 2.37,
      "type": "final"
    },
    {
      "start": "2025-04-01T11:00:00.000Z",
      "usage": 2.44,
      "type": "final"
    },
    {
      "start": "2025-04-01T11:15:00.000Z",
      "usage": 2.51,
      "type": "final"
    },
    {
      "start": "2025-04-01T11:30:00.000Z",
      "usage": 2.58,
      "type": "final"
    },
    {
      "start": "2025-04-01T11:45:00.000Z",
      "usage": 2.65,
      "type": "final"
    },
    {
      "start": "2025-04-01T12:00:00.000Z",
      "usage": 2.72,
      "type": "final"
    },
    {
      "start": "2025-04-01T12:15:00.000Z",
      "usage": 2.79,
      "type": "final"
    },
    {
      "start": "2025-04-01T12:30:00.000Z",
      "usage": 2.86,
      "type": "final"
    },
    {
      "start": "2025-04-01T12:45:00.000Z",
      "usage": 2.93,
      "type": "final"
    },
    {
      "start": "2025-04-01T13:00:00.000Z",
      "usage": 3,
      "type": "final"
    },
    {
      "start": "2025-04-01T13:15:00.000Z",
      "usage": 3.07,
      "type": "final"
    },
    {
      "start": "2025-04-01T13:30:00.000Z",
      "usage": 3.14,
      "type": "final"
    },
    {
      "start": "2025-04-01T13:45:00.000Z",
      "usage": 3.21,
      "type": "final"
    },
    {
      "start": "2025-04-01T14:00:00.000Z",
      "usage": 3.28,
      "type": "final"
    },
    {
      "start": "2025-04-01T14:15:00.000Z",
      "usage": 3.35,
      "type": "final"
    },
    {
      "start": "2025-04-01T14:30:00.000Z",
      "usage": 3.42,
      "type": "final"
    },
    {
      "start": "2025-04-01T14:45:00.000Z",
      "usage": 3.49,
      "type": "final"
    },
    {
      "start": "2025-04-01T15:00:00.000Z",
      "usage": 3.56,
      "type": "final"
    },
    {
      "start": "2025-04-01T15:15:00.000Z",
      "usage": 3.63,
      "type": "final"
    },
    {
      "start": "2025-04-01T15:30:00.000Z",
      "usage": 3.7,
      "type": "final"
    },
    {
      "start": "2025-04-01T15:45:00.000Z",
      "usage": 3.77,
      "type": "final"
    },
    {
      "start": "2025-04-01T16:00:00.000Z",
      "usage": 3.84,
      "type": "final"
    },
    {
      "start": "2025-04-01T16:15:00.000Z",
      "usage": 3.91,
      "type": "final"
    },
    {
      "start": "2025-04-01T16:30:00.000Z",
      "usage": 3.98,
      "type": "final"
    },
    {
      "start": "2025-04-01T16:45:00.000Z",
      "usage": 4.05,
      "type": "final"
    },
    {
      "start": "2025-04-01T17:00:00.000Z",
      "usage": 4.12,
      "type": "final"
    },
    {
      "start": "2025-04-01T17:15:00.000Z",
      "usage": 4.19,
      "type": "final"
    },
    {
      "start": "2025-04-01T17:30:00.000Z",
      "usage": 4.26,
      "type": "final"
    },
    {
      "start": "2025-04-01T17:45:00.000Z",
      "usage": 4.33,
      "type": "final"
    },
    {
      "start": "2025-04-01T18:00:00.000Z",
      "usage": 4.4,
      "type": "final"
    },
    {
      "start": "2025-04-01T18:15:00.000Z",
      "usage": 4.47,
      "type": "final"
    },
    {
      "start": "2025-04-01T18:30:00.000Z",
      "usage": 4.54,
      "type": "final"
    },
    {
      "start": "2025-04-01T18:45:00.000Z",
      "usage": 4.61,
      "type": "final"
    },
    {
      "start": "2025-04-01T19:00:00.000Z",
      "usage": 4.68,
      "type": "final"
    },
    {
      "start": "2025-04-01T19:15:00.000Z",
      "usage": 4.75,
      "type": "final"
    },
    {
      "start": "2025-04-01T19:30:00.000Z",
      "usage": 4.82,
      "type": "final"
    },
    {
      "start": "2025-04-01T19:45:00.000Z",
      "usage": 4.89,
      "type": "final"
    },
    {
      "start": "2025-04-01T20:00:00.000Z",
      "usage": 4.96,
      "type": "final"
    },
    {
      "start": "2025-04-01T20:15:00.000Z",
      "usage": 5.03,
      "type": "final"
    },
    {
      "start": "2025-04-01T20:30:00.000Z",
      "usage": 5.1,
      "type": "final"
    },
    {
      "start": "2025-04-01T20:45:00.000Z",
      "usage": 5.17,
      "type": "final"
    },
    {
      "start": "2025-04-01T21:00:00.000Z",
      "usage": 5.24,
      "type": "final"
    },
    {
      "start": "2025-04-01T21:15:00.000Z",
      "usage": 5.31,
      "type": "final"
    },
    {
      "start": "2025-04-01T21:30:00.000Z",
      "usage": 5.38,
      "type": "final"
    },
    {
      "start": "2025-04-01T21:45:00.000Z",
      "usage": 5.45,
      "type": "final"
    }
  ]
}