Skip to main content

GET /market-messages/supplier-mpid/{supplier_mpid}

Retrieves market messages for a supplier MPID, with optional message-type, market-type, and datetime-range filters.

Request​

Method and path:

  • GET /market-messages/supplier-mpid/{supplier_mpid}

Headers:

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

Path parameters:

  • supplier_mpid (required): string supplier MPID.

Query parameters:

  • message_type_name (optional): exact message type name (for example IF-019, CSS1700).
  • market_type (optional): one of dip, dtn, css.
  • received_start (optional): ISO 8601 datetime, lower bound on message created timestamp.
  • received_end (optional): ISO 8601 datetime, upper bound on message created timestamp.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: array of message objects
[
  {
    "id": "72f30f06-afcc-4ad8-8c1f-78e556ea9cbc",
    "message_type_fk": "9bb558b2-15b5-4a36-a4b0-678257f0f2d1",
    "inbound_outbound": "inbound",
    "status": "success",
    "supplier_process_fk": "50309bc1-7f1d-43a2-a1fd-2df9fcf31b5d",
    "message_type": {
      "id": "9bb558b2-15b5-4a36-a4b0-678257f0f2d1",
      "name": "IF-019",
      "type": "dip",
      "description": "Example description"
    },
    "css_message_data": null,
    "dip_message_data": [
      {
        "id": "6048ac51-6504-4fff-ad3d-3535b971fe17",
        "event_code": "IF-019",
        "sender_timestamp": "2026-04-22T12:00:00+00:00",
        "mpan_core": 1234567890123
      }
    ],
    "dtn_message_data": null
  }
]

Other documented responses:

  • 204 No Content when no messages match filters.
  • 400 when market_type is invalid or received_start > received_end.
  • 401 Unauthorized.

Field-level constraints: