Skip to main content

GET /consumption/v1/{mpid}/load-shapes/period

Returns the latest settlement load shape period data for a settlement date and optional market filters.

Request​

Method and path:

  • GET /consumption/v1/{mpid}/load-shapes/period?settlement_date=2026-03-01&gsp_group_id=A&connection_type=H&market_segment=A&domestic_indicator=Y&mqid=AI

Headers:

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

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • settlement_date (required): string date in YYYY-MM-DD.
  • gsp_group_id (optional): string GSP group identifier.
  • connection_type (optional): string connection type.
  • market_segment (optional): string market segment.
  • domestic_indicator (optional): string domestic indicator.
  • mqid (optional): string measurement quantity ID.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: SettlementLoadShapePeriodResponse
{
  "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": [
    {
      "effective_to": "2026-03-01T00:30:00+00:00",
      "ls_period_value": "0.01825",
      "default_flag": "N"
    }
  ]
}

No content case:

  • 204 No Content when no load shape period data matches the filters.

Validation error:

  • 422-style SSI validation response when settlement_date is not YYYY-MM-DD.

Full field definitions: