v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
REMIT

List messages by event time (stream)

This endpoint provides a list of REMIT message identifiers based on the event start, end time and other optional parameters.

  • Filtering by LatestRevisionOnly (default = true): if true, include only the latest revision of each message.

  • Filtering by ProfileOnly (default = false): if true, include only messages with an outage profile.

This endpoint has an optimised JSON payload and is aimed at frequent requests for this data.

get/remit/list/by-event/stream

Query parameters

fromstring date-time required
Example:2023/04/13 07:00
tostring date-time required
Example:2023/04/14 07:00
participantIdstring
Example:EECL
assetIdstring
Example:T_RATSGT-2
messageTypestring
Example:UnavailabilitiesOfElectricityFacilities
unavailabilityTypestring
Example:Planned
eventTypestring[]
[
  "Production Unavailability",
  "Transmission unavailability"
]
fuelTypestring[]
[
  "Fossil Hard coal",
  "Biomass"
]
latestRevisionOnlyboolean
Example:true
profileOnlyboolean

Response

Data retrieved

idinteger
mridstring nullable
revisionNumberinteger
createdTimestring date-time
publishTimestring date-time
urlstring nullable

Example response

[
  {
    "id": 24,
    "mrid": "11XINNOGY------2-NGET-RMT-00084421",
    "revisionNumber": 2,
    "createdTime": "2023-01-31T17:39:15Z",
    "publishTime": "2023-01-31T17:15:31Z",
    "url": "https://data.elexon.co.uk/bmrs/api/v1/remit/24"
  }
]