v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Load Shape

Load shape period data stream (IF022)

This endpoint provides a stream 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 parameters must be provided in the exact format yyyy-MM-dd.

get/lss/load-shape-period/stream

Query parameters

fromDatestring date required
Example:2026-03-01

The settlement date range start (inclusive). This must be in the format yyyy-MM-dd.

toDatestring date required
Example:2026-03-02

The settlement date range end (inclusive). This must be in the format yyyy-MM-dd.

settlementPeriodFrominteger
Example:40

Optional settlement period range start (inclusive).

settlementPeriodTointeger
Example:2

Optional settlement period range end (inclusive).

Response

Data retrieved

sourceFileNamestring nullable
sourceFileDatetimestring date-time
settlementDatestring date
settlementPeriodStartDateTimestring date-time
settlementPeriodEndDateTimestring date-time
settlementPeriodinteger
gspGroupIdstring nullable
connectionTypeIndicatorstring nullable
marketSegmentIndicatorstring nullable
domesticPremiseIndicatorstring nullable
measurementQuantityIdstring nullable
runNumberinteger
eventCodestring nullable
settlementPeriodDurationinteger
loadShapePeriodValuenumber double
defaultLoadShapeFlagstring nullable