The GridLive API

The GridLive API is available at  api.gridlive.sheffield.ac.uk  and detailed documentation is available online.

To get access to the GridLive API, e-mail Edwin Brown at w.e.brown at sheffield.ac.uk.

Data and metadata end points

The API is has two main end points:

• the  /smart_meter/  end point provides access to time-series smart meter energy consumption data; and

• the  /esa_metadata/  end point describes the electricty supply areas for which time energy consumption data is available.

Each of these in turn has the following:

• the  /  end point which returns all data;

• the  /esa/{esa_id}  end point which returns data for a given Electricity Supply Area;

• the  /license_area/{license_area}  end point which returns all data within a given License Area;

• the  /dno/{dno}  end point which returns all data for a given Distribution Network Operator;

• the  /in/{grid_reference}  end point which returns all data within an UK Ordnance Survey Grid Reference; and

• the  /near/{grid_reference}  end point which returns all data within a given radius of the centre of an UK Ordnance Survey Grid Reference.

General information end points

To help relate Distribution Network Operators (DNOs) to their License Areas (LAs), a set of four end points are also supplied:

• the  /license_area/  end point provides a list of LAs; 

• the  /license_area/{dno}  end point provides a list of LAs for a given DNO; 

• the  /dno/  end point provides a list of DNOs; and 

• the  /dno/{license_area}  end point provide the DNO of a given LA.

API Access Examples