Skip to main content

GET /consumption/v1/{mpid}/load-shapes/received-on-or-after

Returns period and totals load shape updates received on or after a supplied timestamp.

Request​

Method and path:

  • GET /consumption/v1/{mpid}/load-shapes/received-on-or-after?received_on=2026-03-20T00:00:00+00:00

Headers:

  • X-API-KEY (required): string, API key used for tenant authorization.

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • received_on (required): string datetime in ISO 8601 format.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: object with lss_periods and lss_totals arrays
{
  "lss_periods": [
    {
      "received_on": "2026-03-20T01:00:00+00:00",
      "settlement_date": "2026-03-01T00:00:00+00:00",
      "period_duration": 30,
      "gsp_group_id": "A",
      "connection_type": "H",
      "market_segment": "A",
      "domestic_indicator": "Y",
      "mqid": "AI",
      "lss_period_data": []
    }
  ],
  "lss_totals": [
    {
      "received_on": "2026-03-20T01:00:00+00:00",
      "settlement_date": "2026-03-01T00:00:00+00:00",
      "gsp_group_id": "A",
      "connection_type": "H",
      "market_segment": "A",
      "domestic_indicator": "Y",
      "mqid": "AI",
      "annual_load_shape_total": "12.88400",
      "lss_totals_data": []
    }
  ]
}

No content case:

  • 204 No Content when neither period nor totals updates are found.

Validation error:

  • 422-style SSI validation response when received_on is not valid ISO 8601.

Full field definitions: