Skip to main content

GET /consumption/v1/{mpid}

Returns settlement consumption data for one MPAN and date, or changed records after an updated_on date.

Request​

Method and path:

  • GET /consumption/v1/{mpid}?mpan_core=1234567890123&from_date=2026-03-01
  • GET /consumption/v1/{mpid}?updated_on=2026-03-20

Headers:

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

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • mpan_core (conditionally required): integer MPAN core. Required when updated_on is not provided.
  • from_date (conditionally required): string date in YYYY-MM-DD. Required when updated_on is not provided.
  • updated_on (optional): string date in YYYY-MM-DD. When supplied, mpan_core and from_date can be omitted.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: array of SettlementRunResponseSchema
[
  {
    "mpan_core": 1234567890123,
    "data_service_dip_id": "DIP-DC-001",
    "connection_type": "H",
    "measurement_quantity_id": "AI",
    "utc_settlement_date": "2026-03-01T00:00:00+00:00",
    "settlement_period_duration": 30,
    "consumption_data": [
      {
        "utc_effective_to_datetime": "2026-03-01T00:30:00+00:00",
        "consumption_value": "0.482",
        "quality_indicator": "A",
        "estimation_reason_code": null,
        "amendment_reason_code": null
      }
    ]
  }
]

No content case:

  • 204 No Content when no settlement runs match the filters.

Validation notes:

  • updated_on must be YYYY-MM-DD when supplied.
  • If updated_on is omitted, both mpan_core and from_date are required.
  • mpan_core must be an integer and 13 digits long.
  • from_date must be YYYY-MM-DD.

Full field definitions: