v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Load Shape

Load shape period data (IF022)

This endpoint enables the retrieval of load shape period (IF022) data for a specified date and settlement period range.

For more information on Load shape data & load shape categories please view the <a href="https://www.mhhsprogramme.co.uk/api/documentlibrary/Design%20Documents/MHHSP_METH005%20LSS_Method_Statement%20v5.3.pdf" target="_blank">LSS method statement</a>.

Date parameter must be provided in the exact format yyyy-MM-dd.

get/lss/load-shape-period

Query parameters

datestring date required
Example:2026-03-01

The settlement date to return load shape period data for. This must be in the format yyyy-MM-dd.

settlementPeriodFrominteger
Example:1

Optional settlement period range start (inclusive).

settlementPeriodTointeger
Example:10

Optional settlement period range end (inclusive).

format'json' | 'xml' | 'csv'

Response data format. Use json/xml to include metadata.

Response

Data retrieved

Example response

{
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}