v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Trading unit data (S0491_TUDM)

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

get/datasets/TUDM

Query parameters

settlementDatestring date required

Example:2023-10-05

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

settlementPeriodinteger required

Example:10

tradingUnitNamestring[]

[
  "DEFAULT__A"
]

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

Example:Base

format'json' | 'xml' | 'csv'

Response data format. Use json/xml to include metadata.

Response

Data retrieved

Example response

{
  "data": [
    {
      "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
    }
  ]
}