v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Accepted Offered Balancing Energy (AOBE) stream

This endpoint provides accepted offered balancing energy data.

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

get/datasets/AOBE/stream

Query parameters

publishDateTimeFromstring date-time required

Example:2023-11-06T00:00:00Z

publishDateTimeTostring date-time required

Example:2023-11-13T00:00:00Z

Response

Data retrieved

datasetstring nullable

documentIdstring nullable

timeSeriesIdstring nullable

documentRevisionNumberinteger

publishTimestring date-time

flowDirectionstring nullable

quantitynumber double

secondaryQuantitynumber double nullable

startTimestring date-time

settlementDatestring date

settlementPeriodinteger

Example response

[
  {
    "dataset": "AOBE",
    "documentId": "NGET-EMFIP-AOBE-00879999",
    "timeSeriesId": "NGET-EMFIP-AOBE-36758603",
    "documentRevisionNumber": 1,
    "publishTime": "2023-10-24T13:09:07Z",
    "flowDirection": "Up",
    "quantity": 12412,
    "secondaryQuantity": 45.831,
    "startTime": "2023-09-11T14:30:00Z",
    "settlementDate": "2023-09-11",
    "settlementPeriod": 32
  }
]