v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Trading unit data (S0491_TUDM) stream

This endpoint provides trading unit data filtered by settlement period, trading unit name and type.

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

get/datasets/TUDM/stream

Query parameters

settlementDateFromstring date required

Example:2023-10-05

The settlement date to filter from. This must be in the format yyyy-MM-dd.

settlementPeriodFrominteger required

Example:10

settlementDateTostring date required

Example:2023-10-05

The settlement date to filter to. This must be in the format yyyy-MM-dd.

settlementPeriodTointeger required

Example:11

tradingUnitNamestring[]

[
  "DEFAULT__A"
]

tradingUnitType'Base' | 'Sole' | 'Others'

Example:Base

Response

Data retrieved

datasetstring nullable

serialNumberstring nullable

fileCreationTimestring date-time

tradingUnitTypestring nullable

tradingUnitNamestring nullable

settlementDatestring date

settlementPeriodinteger

settlementRunTypestring nullable

startTimestring date-time

deliveryModestring nullable

importVolumenumber double

exportVolumenumber double

netVolumenumber double

Example response

[
  {
    "dataset": "TUDM",
    "serialNumber": "000000980321",
    "fileCreationTime": "2023-10-19T07:01:07.000",
    "tradingUnitType": "Base",
    "tradingUnitName": "DEFAULT__A",
    "settlementDate": "2022-07-30",
    "settlementPeriod": 5,
    "settlementRunType": "RF",
    "startTime": "2022-07-30T10:30:00Z",
    "deliveryMode": "Offtaking",
    "importVolume": 209.95,
    "exportVolume": -1372.384,
    "netVolume": -1162.434
  }
]