Skip to content

Netstream API - Getting started

Netstream API gives your applications secure access to your Netstream metering data. By following the steps below, your development team can enhance your applications with access to on-demand meter data.

Totally new to Netstream? Start here.

API Summary

The Netstream API is message based. The messages conform to the Common Information Model (CIM) profiles which are specified by the International Electrotechnical Commission (IEC) in various standards, notably IEC 61968-9:2013. We plan to progressively enlarge the API by rolling out more of these profiles over time. The IEC standard defines profiles for customer information, tariffs, load control, metering, payment metering and asset management – basically everything you need in a utility metering system.

APIs are invoked using a REST idiom, that is, by posting a request profile over http/https to a URI and receiving a response profile in return. Request and response messages are either JSON or XML encoded. The client can specify which format is required by setting the appropriate HTTP header.

Currently, there is just one profile supported in the API, GetMeterReadings. This method is used to obtain meter readings from a usage point, usage point group, meter or meter group.

A tool like cURL or Postman to send HTTP requests would be handy when familiarising yourself with the API.

Authentication

The steps in this section can only be performed by users with the Retailer Admin role. You can check your role under the My details section of My Settings.

Before you can use the Netstream API you will need to create an API token.

Errors

Netstream uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (such as a required parameter was omitted). Codes in the 5xx range indicate an error with Netstream servers (these are rare).

The search parameters are contained in the GetXYZ payload. Some top-level API resource have support for retrieval via “search” API methods. The "get" verb is used to issue a query request to Netstream to return a set of zero or more objects that meet a specified criteria. Search APIs are of the format GetXYZ where XYZ is the name of some searchable item. By convention, the GetXYZ method would return an object of type XYZ.