Skip to main content

GET /readings/v1/{mpid}

Returns readings received on or after a supplied timestamp, optionally limited to one MPAN.

Request​

Method and path:

  • GET /readings/v1/{mpid}?received_on=2026-03-20T00:00:00+00:00&mpan_id=1234567890123

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.
  • mpan_id (optional): integer MPAN core.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: array of ReadingResponse
[
  {
    "id": "b80dd257-5536-4b1c-ae58-1d4314948efb",
    "received_on": "2026-03-20T08:15:00+00:00",
    "reading_type": "C",
    "sender_mpid": "MOP1",
    "sender_role": "M",
    "receiver_mpid": "ABCD",
    "receiver_role": "X",
    "mpan_core": 1234567890123,
    "cumulative_readings": [
      {
        "meter_id": "A1B2C3D4E5",
        "cumulative_register_reading": "001234",
        "cumulative_reading_datetime": "2026-03-20T08:00:00+00:00",
        "reading_method": "A",
        "site_visit_check_code": null,
        "site_visit_additional_information": null,
        "registers": [
          {
            "register_id": "01",
            "register_reading": "001234",
            "register_reading_datetime": "2026-03-20T08:00:00+00:00",
            "number_of_md_resets": null,
            "md_reset_datetime": null,
            "meter_reading_flag": null,
            "reading_method": null,
            "reason_code": null,
            "reading_status": null,
            "site_visit_check_code": null,
            "site_visit_check_code_additional_information": null
          }
        ]
      }
    ]
  }
]

No content case:

  • 204 No Content when no readings match the filters.

Validation error:

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

Full field definitions: