Skip to content

Netstream API - Samples

Get Historical Meter Readings

Use the (GetMeterReadings)[https://] end point to fetch historical readings from Netstream by passing in a GetMeterReadings object and receiving a MeterReadings2 object.

Three pieces of information are needed in the input:

  1. A Reading object with one time period specifying the date range of interest. Example: 

        "reading":
    [
        {
            "timePeriod":
            {
                "end": "2025-03-02T00:00:00+11:00",
                "endSpecified": false,
                "start": "2025-03-01T00:00:00+11:00",
                "startSpecified": true
            }
        }
    ]

  2. One or more reading types. Please refer to this list. Example: 

        "readingType":
    [
        {
            "mRID": "0.0.5.4.1.1.12.0.0.0.0.0.0.0.224.3.72.0"
        }
    ]

  3. The master resource ID (MRID) of a Usage Point or End Device (meter), or groups thereof. Example for a usage point: 

        "usagePoint":
    [
        {
            "mRID": "00000000-0000-0000-0000-000000000000"
        }
    ]

NOTE

ⓘ You can obtain a usage point MRID from Netstream Provisioning Report by un-hiding the MRID column. Click the three dots beside any column header to see a menu to edit column settings.

More than one reading type or usage point can be specified in the same request. In this example four time series are returned, two for each usage point being thirtyMinute deltaData export energy PhaseABC (kWh) and the same aggregated to twentyfourHour periods. 

    "readingType":
    [
        {
            "mRID": "0.0.5.4.1.1.12.0.0.0.0.0.0.0.224.3.72.0"
        },
        {
            "mRID": "0.0.4.4.1.1.12.0.0.0.0.0.0.0.224.3.72.0"
        }
    ],
    "usagePoint":
    [
        {
            "mRID": "00000000-0000-0000-0000-000000000000"
        },
        {
            "mRID": "00000000-0000-0000-0000-000000000001"
        }
    ]

If successful, a MeterReadings is received in response.

Three key pieces of information in the response are:

  1. If an interval readings reading type was specified then an intervalBlockInts array containing interval readings over the range specified, depending on what is available. Example: 
                "intervalBlockInts":
            [
                {
                    "timePeriod":
                    {
                        "end": "2025-03-02T00:00:00",
                        "endSpecified": true,
                        "start": "2025-03-01T00:00:00",
                        "startSpecified": true
                    },
                    "values":
                    [ // array of sample values (omitted for brevity)
                    ],
                    "flags":
                    [   // array of flags
                    ],
                    "readingTypeMrid": "0.0.5.4.1.1.12.0.0.0.0.0.0.0.224.3.72.0"
                },
                // ... etc
            ]

NOTE

ⓘ The values array and flags array have the same length which is equal to the number samples returned by the query. At a given array index a reading and its quality flags come as a pair.

Reading quality flags are explained here.

  1. If time of use (ToU) reading type was specified then a ReadingInts object containing meter readings over the range specified, depending on what is available. Example:
            "readingInts":
            [
                {
                    "readingTypeMrid": "8.0.0.4.1.1.12.0.0.0.0.0.0.0.224.3.72.0",
                    "value": 12845.963,
                    "flags": 1,
                    "tStart": "2025-01-01T00:00:00",
                    "tEnd": "2025-02-01T00:00:00",
                    "t": "0001-01-01T00:00:00",
                    "tReported": "2025-02-01T02:07:58.5256507",
                    "reason": "billing"
                },  // etc
  1. The usage point MRID to which the readings relate.