openapi: 3.0.4
info:
  title: Insights.Api Balancing Mechanism Dynamic BMRS Datasets API
  version: '1.0'
  description: Dynamic data.
servers:
- url: https://data.elexon.co.uk/bmrs/api/v1
tags:
- name: BMRS Datasets
  description: Raw datasets as received from the National Grid, with associated metadata. The output in JSON format matches IRIS, and can be used interchangeably with IRIS output.
paths:
  /datasets/NONBM:
    get:
      tags:
      - BMRS Datasets
      summary: Non-BM STOR (NONBM)
      description: "This endpoint provides data about the Short Term Operating Reserves (STOR) that have been made use of\nby NGESO. This is activity that is outside of the Balancing Mechanism and takes place to meet the need to\nincrease generation or decrease demand.\n            \nTo retrieve data from a particular time window, use the optional start and end time parameters.\nThese times should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\nIf no time window is chosen, the default output will be the latest published data."
      parameters:
      - name: from
        in: query
        description: The start of the data publish time window.
        schema:
          type: string
          format: date-time
          example: 2022-06-25T13:15Z
        example: 2022-06-25T13:15Z
      - name: to
        in: query
        description: The end of the data publish time window.
        schema:
          type: string
          format: date-time
          example: 2022-06-27T19:45Z
        example: 2022-06-27T19:45Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NONBM/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Non-BM STOR (NONBM) stream
      description: "This endpoint provides data about the Short Term Operating Reserves (STOR) that have been made use of\nby NGESO. This is activity that is outside of the Balancing Mechanism and takes place to meet the need to\nincrease generation or decrease demand.\n            \nTo retrieve data from a particular time window, use the optional start and end time parameters.\nThese times should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\nIf no time window is chosen, the default output will be the latest published data.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the Non-BM STOR data."
      parameters:
      - name: from
        in: query
        description: The start of the data publish time window.
        schema:
          type: string
          format: date-time
          example: 2022-06-25T13:15Z
        example: 2022-06-25T13:15Z
      - name: to
        in: query
        description: The end of the data publish time window.
        schema:
          type: string
          format: date-time
          example: 2022-06-27T19:45Z
        example: 2022-06-27T19:45Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/PN:
    get:
      tags:
      - BMRS Datasets
      summary: Physical Notifications (PN)
      description: "This endpoint provides Physical Notification data received from NGESO. It returns the data valid for a single settlement period.\nA Physical Notification is the best estimate of the level of generation or demand that a participant in the BM expects a BM Unit to export or import, respectively, in a Settlement Period.\n            \nPhysical Notifications are submitted as a series of point MW values.\n            \nThe settlement period to query must be specified as a date and settlement period. The date should be provided in the format yyyy-MM-dd."
      parameters:
      - name: settlementDate
        in: query
        description: The settlement date to query. This must be in the format yyyy-MM-dd.
        required: true
        schema:
          type: string
          format: date
          example: '2022-07-01'
        example: '2022-07-01'
      - name: settlementPeriod
        in: query
        description: The settlement period to query. This should be an integer from 1-50 inclusive.
        required: true
        schema:
          type: integer
          format: int32
          example: 5
        example: 5
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_ABRBO-1
        example:
        - T_ABRBO-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/PN/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Physical Notifications (PN) stream
      description: "This endpoint provides Physical Notification data received from NGESO.\nA Physical Notification is the best estimate of the level of generation or demand that a participant in the BM expects a BM Unit to export or import, respectively, in a Settlement Period.\n            \nPhysical Notifications are submitted as a series of point MW values.\n            \nThe settlement period to query can be specified as a date and settlement period, or as a datetime\nwhich will resolve to the settlement period that time falls within.\nIf a settlement period is provided, it will take precedence over the time portion of the datetime.\n\nSome examples of date parameter combinations are shown below.\n            \nFiltering from settlement datetime to settlement datetime:\n            \n     /datasets/PN/stream?from=2022-07-01T00:00Z&to=2022-07-03T06:00Z\n            \nFiltering from settlement datetime to settlement date and period:\n            \n     /datasets/PN/stream?from=2022-07-01T00:00Z&to=2022-07-03&settlementPeriodTo=15\n            \nFiltering from settlement date and period to settlement datetime:\n            \n     /datasets/PN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03T06:00Z\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/PN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03&settlementPeriodTo=15\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for PN data."
      parameters:
      - name: from
        in: query
        description: The settlement date to query from.
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-07-01'
        example: '2022-07-01'
      - name: to
        in: query
        description: The settlement date to query up to.
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-07-03'
        example: '2022-07-03'
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
          example: 3
        example: 3
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
          example: 15
        example: 15
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_ABRBO-1
        example:
        - T_ABRBO-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/QPN:
    get:
      tags:
      - BMRS Datasets
      summary: Quiescent Physical Notifications (QPN)
      description: "This endpoint provides Quiescent Physical Notification data received from NGESO. It returns the data valid for a single settlement period.\nQuiescent Physical Notifications describe the MW levels to be deducted from the Physical Notification of a BM Unit to determine a resultant operating level.\n            \nThe settlement period to query must be specified as a date and settlement period. The date should be provided in the format yyyy-MM-dd."
      parameters:
      - name: settlementDate
        in: query
        description: The settlement date to query. This must be in the format yyyy-MM-dd.
        required: true
        schema:
          type: string
          format: date
          example: '2022-07-01'
        example: '2022-07-01'
      - name: settlementPeriod
        in: query
        description: The settlement period to query. This should be an integer from 1-50 inclusive.
        required: true
        schema:
          type: integer
          format: int32
          example: 5
        example: 5
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_ABRBO-1
        example:
        - T_ABRBO-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/QPN/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Quiescent Physical Notifications (QPN) stream
      description: "This endpoint provides Quiescent Physical Notification data received from NGESO.\nQuiescent Physical Notifications describe the MW levels to be deducted from the Physical Notification of a BM Unit to determine a resultant operating level.\n            \nThe settlement period to query can be specified as a date and settlement period, or as a datetime\nwhich will resolve to the settlement period that time falls within.\nIf a settlement period is provided, it will take precedence over the time portion of the datetime.\n\nSome examples of date parameter combinations are shown below.\n            \nFiltering from settlement datetime to settlement datetime:\n            \n     /datasets/QPN/stream?from=2022-07-01T00:00Z&to=2022-07-03T06:00Z\n            \nFiltering from settlement datetime to settlement date and period:\n            \n     /datasets/QPN/stream?from=2022-07-01T00:00Z&to=2022-07-03&settlementPeriodTo=15\n            \nFiltering from settlement date and period to settlement datetime:\n            \n     /datasets/QPN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03T06:00Z\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/QPN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03&settlementPeriodTo=15\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for QPN data."
      parameters:
      - name: from
        in: query
        description: The settlement date to query from.
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-07-01'
        example: '2022-07-01'
      - name: to
        in: query
        description: The settlement date to query up to.
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-07-03'
        example: '2022-07-03'
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
          example: 3
        example: 3
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
          example: 15
        example: 15
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_ABRBO-1
        example:
        - T_ABRBO-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MELS:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Export Limit (MELS)
      description: "This endpoint provides Maximum Export Limit data received from NGESO.\n\nThe Maximum Export Limit is the maximum power export level of a particular BM Unit at a particular time.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nMELs are submitted as a series of MW values and associated times in UTC.\n\nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T00:00Z
        example: 2022-10-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T01:00Z
        example: 2022-10-12T01:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_DRAXX-1
        example:
        - T_DRAXX-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MELS/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Export Limit (MELS) stream
      description: "This endpoint provides Maximum Export Limit data received from NGESO.\n\nThe Maximum Export Limit is the maximum power export level of a particular BM Unit at a particular time.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nMELs are submitted as a series of MW values and associated times in UTC.\n\nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MELS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T00:00Z
        example: 2022-10-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T01:00Z
        example: 2022-10-12T01:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_DRAXX-1
        example:
        - T_DRAXX-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MILS:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Import Limit (MILS)
      description: "This endpoint provides Maximum Import Limit data received from NGESO.\n\nThe maximum power import level of a particular BM Unit at a particular time.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nMILs are submitted as a series of MW values and associated times in UTC.\n\nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T00:00Z
        example: 2022-10-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T01:00Z
        example: 2022-10-12T01:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_DRAXX-1
        example:
        - T_DRAXX-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MILS/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Import Limit (MILS) stream
      description: "This endpoint provides Maximum Import Limit data received from NGESO.\n\nThe maximum power import level of a particular BM Unit at a particular time.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nMILs are submitted as a series of MW values and associated times in UTC.\n\nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MILS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T00:00Z
        example: 2022-10-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-12T01:00Z
        example: 2022-10-12T01:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_DRAXX-1
        example:
        - T_DRAXX-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/QAS:
    get:
      tags:
      - BMRS Datasets
      summary: Balancing Services Volume (QAS)
      description: "This endpoint provides Balancing Services Volume data received from NGESO.\n            \nBalancing Services Volume is a volume which is received from the System Operator, which represents the volume\nof energy (MWh) associated with the provision of Applicable Balancing Services for each relevant BM Unit and\nSettlement Period.\n\nQAS can be positive or negative and is normally only provided where there is a non-zero volume.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-12T00:00Z
        example: 2022-08-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-13T00:00Z
        example: 2022-08-13T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_CNQPS-1
        example:
        - T_CNQPS-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/QAS/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Balancing Services Volume (QAS) stream
      description: "This endpoint provides Balancing Services Volume data received from NGESO.\n            \nBalancing Services Volume is a volume which is received from the System Operator, which represents the volume\nof energy (MWh) associated with the provision of Applicable Balancing Services for each relevant BM Unit and\nSettlement Period.\n\nQAS can be positive or negative and is normally only provided where there is a non-zero volume.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-12T00:00Z
        example: 2022-08-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-13T00:00Z
        example: 2022-08-13T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_CNQPS-1
        example:
        - T_CNQPS-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NETBSAD:
    get:
      tags:
      - BMRS Datasets
      summary: Net Balancing Services Adjustment Data (NETBSAD)
      description: "This endpoint provides Net Balancing Services Adjustment data received from NGESO.\n            \nNet Balancing Services Adjustment data covers the buy/sell price, cost and volume adjustments for each\nsettlement period. \n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-10T00:00Z
        example: 2022-10-10T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-17T00:00Z
        example: 2022-10-17T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NETBSAD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Net Balancing Services Adjustment Data (NETBSAD)
      description: "This endpoint provides Net Balancing Services Adjustment data received from NGESO.\n            \nNet Balancing Services Adjustment data covers the buy/sell price, cost and volume adjustments for each\nsettlement period. \n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for NETBSAD data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-10T00:00Z
        example: 2022-10-10T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-17T00:00Z
        example: 2022-10-17T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DISBSAD:
    get:
      tags:
      - BMRS Datasets
      summary: Disaggregated Balancing Services Adjustment Data (DISBSAD)
      description: "This endpoint provides Disaggregated Balancing Services Adjustment data received from NGESO.\n            \nDisaggregated Balancing Services Adjustment data covers a set of adjustment actions, cost and volume values\nfor each Settlement Period. Adjustment costs are shown in £. Adjustment volumes are shown in MWh.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-10T00:00Z
        example: 2022-10-10T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-11T00:00Z
        example: 2022-10-11T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DISBSAD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Disaggregated Balancing Services Adjustment Data (DISBSAD) stream
      description: "This endpoint provides Disaggregated Balancing Services Adjustment data received from NGESO.\n            \nDisaggregated Balancing Services Adjustment data covers a set of adjustment actions, cost and volume values\nfor each Settlement Period. Adjustment costs are shown in £. Adjustment volumes are shown in MWh.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for DISBSAD data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-10T00:00Z
        example: 2022-10-10T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-11T00:00Z
        example: 2022-10-11T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/BOD:
    get:
      tags:
      - BMRS Datasets
      summary: Bid Offer Data (BOD)
      description: "This endpoint provides bid-offer data.\n            \nBy default, the from and to parameters filter the data inclusively and this endpoint will return any data where\nTimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are\nprovided, it will instead filter to return any data where TimeFrom is within the specified range of settlement\nperiods. It is possible to search using a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored.\nFor example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from a datetime to a datetime\n            \n    /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from a datetime to a settlement date and period:\n            \n    /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from a settlement date and period to a datetime:\n            \n    /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from a settlement date and period to a settlement date and period:\n            \n    /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-09-22T00:00Z
        example: 2022-09-22T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-09-22T01:00Z
        example: 2022-09-22T01:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - 2__HFLEX001
        example:
        - 2__HFLEX001
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/BOD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Bid-Offer Data (BOD) stream
      description: "This endpoint provides bid-offer data.\n            \nBy default, the from and to parameters filter the data inclusively and this endpoint will return any data where\nTimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are\nprovided, it will instead filter to return any data where TimeFrom is within the specified range of settlement\nperiods. It is possible to search using a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored.\nFor example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from datetime to datetime\n            \n    /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from datetime to settlement date and period:\n            \n    /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to datetime:\n            \n    /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-09-22T00:00Z
        example: 2022-09-22T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-09-22T01:00Z
        example: 2022-09-22T01:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - 2__HFLEX001
        example:
        - 2__HFLEX001
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/BOALF:
    get:
      tags:
      - BMRS Datasets
      summary: Bid Offer Acceptance Level Flagged (BOALF)
      description: "This endpoint provides bid offer acceptance data.\n            \nBy default, the from and to parameters filter the data inclusively and this endpoint will return any data where\nTimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are\nprovided, it will instead filter to return any data where TimeFrom is within the specified range of settlement\nperiods. It is possible to search using a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored.\nFor example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from datetime to datetime\n            \n    /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from datetime to settlement date and period:\n            \n    /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to datetime:\n            \n    /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-22T00:00Z
        example: 2022-10-22T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-23T00:00Z
        example: 2022-10-23T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_WBURB-3
        example:
        - T_WBURB-3
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/BOALF/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Bid Offer Acceptance Level Flagged (BOALF) stream
      description: "This endpoint provides bid offer acceptance data.\n            \nBy default, the from and to parameters filter the data inclusively and this endpoint will return any data where\nTimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are\nprovided, it will instead filter to return any data where TimeFrom is within the specified range of settlement\nperiods. It is possible to search using a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored.\nFor example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from datetime to datetime\n            \n    /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from datetime to settlement date and period:\n            \n    /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to datetime:\n            \n    /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-22T00:00Z
        example: 2022-10-22T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-10-23T00:00Z
        example: 2022-10-23T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_WBURB-3
        example:
        - T_WBURB-3
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MID:
    get:
      tags:
      - BMRS Datasets
      summary: Market Index Data (MID)
      description: "This endpoint provides Market Index Data received from NGESO.\n            \nMarket Index Data is a key component in the calculation of System Buy Price and System Sell Price for each\nSettlement Period. This data is received from each of the appointed Market Index Data Providers (MIDPs) and\nreflects the price of wholesale electricity in Great Britain in the short term markets. The Market Index Data\nwhich is received from each MIDP for each Settlement Period consists of a Market Index Volume and\nMarket Index Price, representing the volume and price of trading for the relevant period in the market operated\nby the MIDP. The Market Price (the volume weighed average Market Index Price) is used to derive\nthe Reverse Price (SBP or SSP).\"\n            \nThe two data providers available to query are N2EX (\"N2EXMIDP\") and APX (\"APXMIDP\").\n\nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-12T00:00Z
        example: 2022-08-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-13T00:00Z
        example: 2022-08-13T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: dataProviders
        in: query
        description: The data providers to query. If no data provider is selected both will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - N2EXMIDP
        example:
        - N2EXMIDP
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MID/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Market Index Data (MID) stream
      description: "This endpoint provides Market Index Data received from NGESO.\n            \nMarket Index Data is a key component in the calculation of System Buy Price and System Sell Price for each\nSettlement Period. This data is received from each of the appointed Market Index Data Providers (MIDPs) and\nreflects the price of wholesale electricity in Great Britain in the short term markets. The Market Index Data\nwhich is received from each MIDP for each Settlement Period consists of a Market Index Volume and\nMarket Index Price, representing the volume and price of trading for the relevant period in the market operated\nby the MIDP. The Market Price (the volume weighed average Market Index Price) is used to derive\nthe Reverse Price (SBP or SSP).\"\n            \nThe two data providers available to query are N2EX (\"N2EXMIDP\") and APX (\"APXMIDP\").\n\nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MID data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-12T00:00Z
        example: 2022-08-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-13T00:00Z
        example: 2022-08-13T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: dataProviders
        in: query
        description: The data providers to query. If no data provider is selected both will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - N2EXMIDP
        example:
        - N2EXMIDP
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FUELHH:
    get:
      tags:
      - BMRS Datasets
      summary: Half-hourly generation outturn by fuel type (FUELHH)
      description: "This endpoint provides the half-hourly generation outturn (Generation By Fuel type)\nto give our users an indication of the generation outturn for Great Britain.\nThe data is aggregated by Fuel Type category and updated at 30-minute intervals with\naverage MW values over 30 minutes for each category.\n            \nThis endpoint includes additional settlement parameters such as Settlement Date and Settlement Period.\nThe Settlement Date fields cannot be set when a Publish Date field is set.\n            \nSettlement date parameters must be provided in the exact format yyyy-MM-dd."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-25T00:00:00Z'
        example: '2022-06-25T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-26T00:00:00Z'
        example: '2022-06-26T00:00:00Z'
      - name: settlementDateFrom
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: settlementDateTo
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-21'
        example: '2022-09-21'
      - name: settlementPeriod
        in: query
        description: List of Settlement Periods
        schema:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int32
          example:
          - 3
          - 4
        example:
        - 3
        - 4
      - name: fuelType
        in: query
        description: Fuel Type e.g. NUCLEAR
        schema:
          type: array
          items:
            type: string
          example:
          - NUCLEAR
        example:
        - NUCLEAR
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FUELHH/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Half-hourly generation outturn by fuel type (FUELHH) stream
      description: "This endpoint provides the half-hourly generation outturn (Generation By Fuel type)\nto give our users an indication of the generation outturn for Great Britain.\nThe data is aggregated by Fuel Type category and updated at 30-minute intervals with\naverage MW values over 30 minutes for each category.\n            \nThis endpoint includes additional settlement parameters such as Settlement Date and Settlement Period.\nThe Settlement Date fields cannot be set when a Publish Date field is set.\n            \nSettlement date parameters must be provided in the exact format yyyy-MM-dd.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-25T00:00:00Z'
        example: '2022-06-25T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-26T00:00:00Z'
        example: '2022-06-26T00:00:00Z'
      - name: settlementDateFrom
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: settlementDateTo
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-21'
        example: '2022-09-21'
      - name: settlementPeriod
        in: query
        description: List of Settlement Periods
        schema:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int32
          example:
          - 3
          - 4
        example:
        - 3
        - 4
      - name: fuelType
        in: query
        description: Fuel Type e.g. NUCLEAR
        schema:
          type: array
          items:
            type: string
          example:
          - NUCLEAR
        example:
        - NUCLEAR
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FUELINST:
    get:
      tags:
      - BMRS Datasets
      summary: Instantaneous generation outturn by fuel type (FUELINST)
      description: "This endpoint provides the instantaneous generation outturn (Generation By Fuel type)\nto give our users an indication of the generation outturn for Great Britain.\nThe data is aggregated by Fuel Type category and updated at five-minute intervals\nwith average MW values over 5 minutes for each category.\n            \nThis endpoint includes additional settlement parameters such as Settlement Date and Settlement Period.\nThe Settlement Date fields cannot be set when a Publish Date field is set.\n            \nSettlement date parameters must be provided in the exact format yyyy-MM-dd."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-20T00:00:00Z'
        example: '2022-06-20T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-26T00:00:00Z'
        example: '2022-06-26T00:00:00Z'
      - name: settlementDateFrom
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: settlementDateTo
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-21'
        example: '2022-09-21'
      - name: settlementPeriod
        in: query
        description: List of Settlement Periods
        schema:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int32
          example:
          - 3
          - 4
        example:
        - 3
        - 4
      - name: fuelType
        in: query
        description: Fuel Type e.g. NUCLEAR
        schema:
          type: array
          items:
            type: string
          example:
          - NUCLEAR
        example:
        - NUCLEAR
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FUELINST/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Instantaneous generation outturn by fuel type (FUELINST) stream
      description: "This endpoint provides the instantaneous generation outturn (Generation By Fuel type)\nto give our users an indication of the generation outturn for Great Britain.\nThe data is aggregated by Fuel Type category and updated at five-minute intervals\nwith average MW values over 5 minutes for each category.\n            \nThis endpoint includes additional settlement parameters such as Settlement Date and Settlement Period.\nThe Settlement Date fields cannot be set when a Publish Date field is set.\n            \nSettlement date parameters must be provided in the exact format yyyy-MM-dd.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-20T00:00:00Z'
        example: '2022-06-20T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: '2022-06-26T00:00:00Z'
        example: '2022-06-26T00:00:00Z'
      - name: settlementDateFrom
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: settlementDateTo
        in: query
        schema:
          type: string
          format: date
          example: '2022-09-21'
        example: '2022-09-21'
      - name: settlementPeriod
        in: query
        description: List of Settlement Periods
        schema:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int32
          example:
          - 3
          - 4
        example:
        - 3
        - 4
      - name: fuelType
        in: query
        description: Fuel Type e.g. NUCLEAR
        schema:
          type: array
          items:
            type: string
          example:
          - NUCLEAR
        example:
        - NUCLEAR
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/UOU2T14D:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D)
      description: "This endpoint provides a forward view of availability (also referred to as Output Usable\ndata under the Grid Code) for generation and interconnector capacity, accounting for planned\noutages covering availability data from 2 days ahead to 14 days ahead; it is aggregated by\nNational Grid Balancing Mechanism Units (NGC BMUs).\n            \nIn the context of this report, BMUs can be considered as generating units.\nElexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'.\nThe mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints."
      parameters:
      - name: fuelType
        in: query
        description: The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.
        schema:
          type: array
          items:
            type: string
          example:
          - WIND
        example:
        - WIND
      - name: publishDateTimeFrom
        in: query
        description: 'Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        description: 'End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: bmUnit
        in: query
        description: 'The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.

          If no BM unit is supplied all BM units will be returned.'
        schema:
          type: array
          items:
            type: string
          example:
          - WTMSO-1
        example:
        - WTMSO-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/UOU2T14D/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D) stream
      description: "This endpoint provides a forward view of availability (also referred to as Output Usable\ndata under the Grid Code) for generation and interconnector capacity, accounting for planned\noutages covering availability data from 2 days ahead to 14 days ahead; it is aggregated by\nNational Grid Balancing Mechanism Units (NGC BMUs).\n            \nIn the context of this report, BMUs can be considered as generating units.\nElexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'.\nThe mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: fuelType
        in: query
        description: The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.
        schema:
          type: array
          items:
            type: string
          example:
          - WIND
        example:
        - WIND
      - name: publishDateTimeFrom
        in: query
        description: 'Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        description: 'End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: bmUnit
        in: query
        description: 'The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.

          If no BM unit is supplied all BM units will be returned.'
        schema:
          type: array
          items:
            type: string
          example:
          - WTMSO-1
        example:
        - WTMSO-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/UOU2T3YW:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW)
      description: "This endpoint forward view of availability (also referred to as Output Usable\ndata under the Grid Code) for generation and interconnector capacity, accounting for planned\noutages covering availability data from 2 weeks ahead to 156 weeks ahead; it is aggregated by\nBalancing Mechanism Units (BMUs).\n            \nIn the context of this report, BMUs can be considered as generating units.\nElexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'.\nThe mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints.\n            \nThis endpoint is subject to a limit of 100 requests per minute.\nAny requests made beyond this limit may result in a 429 error (\"Too Many Requests\")"
      parameters:
      - name: fuelType
        in: query
        description: The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.
        schema:
          type: array
          items:
            type: string
          example:
          - CCGT
        example:
        - CCGT
      - name: publishDateTimeFrom
        in: query
        description: 'Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        description: 'End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: bmUnit
        in: query
        description: 'The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.

          If no BM unit is supplied all BM units will be returned.'
        schema:
          type: array
          items:
            type: string
          example:
          - T_CARR-1
        example:
        - T_CARR-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/UOU2T3YW/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW) stream
      description: "This endpoint forward view of availability (also referred to as Output Usable\ndata under the Grid Code) for generation and interconnector capacity, accounting for planned\noutages covering availability data from 2 weeks ahead to 156 weeks ahead; it is aggregated by\nBalancing Mechanism Units (BMUs).\n            \nIn the context of this report, BMUs can be considered as generating units.\nElexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'.\nThe mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: fuelType
        in: query
        description: The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.
        schema:
          type: array
          items:
            type: string
          example:
          - CCGT
        example:
        - CCGT
      - name: publishDateTimeFrom
        in: query
        description: 'Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        description: 'End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.

          If both are omitted, latest published data is returned.'
        schema:
          type: string
          format: date-time
      - name: bmUnit
        in: query
        description: 'The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.

          If no BM unit is supplied all BM units will be returned.'
        schema:
          type: array
          items:
            type: string
          example:
          - T_CARR-1
        example:
        - T_CARR-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FOU2T14D:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 14 days ahead generation availability aggregated by fuel type (FOU2T14D)
      description: "This endpoint provides a forward view of availability (also referred to as Output Usable data\nunder the Grid Code) for generation and interconnector capacity, accounting for planned outages\ncovering 2 days ahead to 14 days ahead; it is aggregated by Fuel Types categories.\n            \nDate parameter must be provided in the exact format yyyy-MM-dd."
      parameters:
      - name: fuelType
        in: query
        schema:
          type: array
          items:
            type: string
      - name: publishDate
        in: query
        description: The publish date for filtering. This must be in the format yyyy-MM-dd.
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: biddingZone
        in: query
        schema:
          type: array
          items:
            type: string
      - name: interconnector
        in: query
        schema:
          type: boolean
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FOU2T3YW:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 156 weeks ahead generation availability aggregated by fuel type (FOU2T3YW)
      description: "This endpoint provides a forward view of availability (also referred to as Output Usable data\nunder the Grid Code) for generation and interconnector capacity, accounting for planned outages\ncovering availability data from 2 weeks ahead to 156 weeks ahead;\nit is aggregated by Fuel Types categories.\n            \nDate parameter must be provided in the exact format yyyy-MM-dd."
      parameters:
      - name: fuelType
        in: query
        schema:
          type: array
          items:
            type: string
      - name: publishDate
        in: query
        description: The publish date for filtering. This must be in the format yyyy-MM-dd.
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: week
        in: query
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: year
        in: query
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: biddingZone
        in: query
        schema:
          type: array
          items:
            type: string
      - name: interconnector
        in: query
        schema:
          type: boolean
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NOU2T14D:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 14 days ahead generation availability aggregated data (NOU2T14D)
      description: "This endpoint provides a forward view of availability (also referred to as Output Usable data\nunder the Grid Code) for generation and interconnector capacity, accounting for planned outages\ncovering 2 days ahead to 14 days ahead. The data is aggregated at national level.\n            \nDate parameter must be provided in the exact format yyyy-MM-dd."
      parameters:
      - name: publishDate
        in: query
        description: The publish date for filtering. This must be in the format yyyy-MM-dd.
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NOU2T3YW:
    get:
      tags:
      - BMRS Datasets
      summary: 2 to 156 weeks ahead generation availability aggregated data (NOU2T3YW)
      description: "This endpoint provides a forward view of availability (also referred to as Output Usable data\nunder the Grid Code) for generation and interconnector capacity, accounting for planned outages\ncovering availability data from 2 weeks ahead to 156 weeks ahead.\nThe data is an aggregation of all Fuel Type categories at national level.\n            \nDate parameter must be provided in the exact format yyyy-MM-dd."
      parameters:
      - name: publishDate
        in: query
        description: The publish date for filtering. This must be in the format yyyy-MM-dd.
        schema:
          type: string
          format: date
          example: '2022-09-20'
        example: '2022-09-20'
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: week
        in: query
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: year
        in: query
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TEMP:
    get:
      tags:
      - BMRS Datasets
      summary: Temperature data (TEMP)
      description: 'This endpoint provides the average degree celsius value measured at midday deemed to be

        representative of the temperature for Great Britain. Data is gathered from 6 weather stations.

        Default output will be the last 31 days. Values are received from 5pm each day.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDGEN:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated generation (INDGEN)
      description: 'This endpoint provides the indicated generation received from NGESO. Data is received daily, by

        midday. Expressed as an average MW value for each Settlement period. The indicated generation

        forecast for each period is the sum of all the PNs submitted for BM Units which are forecast to

        be exporting energy, presented as a single average MW value for the settlement period.


        This API endpoint provides a maximum data output range of 1 day.'
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDGEN/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated generation (INDGEN) stream
      description: 'This endpoint provides the indicated generation received from NGESO. Data is received daily, by

        midday. Expressed as an average MW value for each settlement period. The indicated generation

        forecast for each period is the sum of all the PNs submitted for BM Units which are forecast to

        be exporting energy, presented as a single average MW value for the settlement period.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDDEM:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated demand (INDDEM)
      description: "This endpoint provides the indicated demand forecast for the current day and day-ahead received\nfrom NGESO. The forecast is updated every half hour. The forecast for each period is the sum of\nall the PNs submitted for BM Units which are forecast to be importing energy. Data is presented\nan average MW for the settlement period.\n            \nThis API endpoint provides a maximum data output range of 1 day."
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDDEM/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated demand (INDDEM) stream
      description: 'This endpoint provides the indicated demand forecast for the current day and day-ahead received

        from NGESO. The forecast is updated every half hour. The forecast for each period is the sum of

        all the PNs submitted for BM Units which are forecast to be importing energy. Data is presented

        an average MW for the settlement period.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MELNGC:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated margin (MELNGC)
      description: "This endpoint provides the indicated margin. Data is received every half an hour from NGESO.\nExpressed as an average MW value for each settlement period. The indicated margin forecast for\neach settlement period is the difference between the sum of the MELs submitted for that period,\nand the National Demand forecast made by the System Operator. The greater the value, the higher\nthe margin between available generation capacity and forecast demand - that is to say, the more\nspare capacity there is forecast to be in the system.\n            \nThis API endpoint provides a maximum data output range of 1 day."
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MELNGC/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated margin (MELNGC) stream
      description: 'This endpoint provides the indicated margin. Data is received every half an hour from NGESO.

        Expressed as an average MW value for each settlement period. The indicated margin forecast for

        each settlement period is the difference between the sum of the MELs submitted for that period,

        and the National Demand forecast made by the System Operator. The greater the value, the higher

        the margin between available generation capacity and forecast demand - that is to say, the more

        spare capacity there is forecast to be in the system.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/IMBALNGC:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated imbalance (IMBALNGC)
      description: "This endpoint provides the indicated imbalance. Data is received by daily by midday from NGESO.\nExpressed as an average MW value for each settlement period. The indicated imbalance forecast for\neach period is the difference between the sum of the PNs submitted for generation BM Units (i.e.\nthe indicated generation), and the Transmission System Demand forecast made by the System Operator.\n            \nThis API endpoint provides a maximum data output range of 1 day."
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/IMBALNGC/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead indicated imbalance (IMBALNGC) stream
      description: 'This endpoint provides the indicated imbalance. Data is received by daily by midday from NGESO.

        Expressed as an average MW value for each settlement period. The indicated imbalance forecast for

        each period is the difference between the sum of the PNs submitted for generation BM Units (i.e.

        the indicated generation), and the National Demand forecast made by the System Operator.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDF:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead National Demand forecast (NDF)
      description: "This endpoint provides the National Demand forecast received from NGESO. Data is available\ndaily and will show values for the day ahead. Expressed as an average MW\nvalue for each settlement period. The forecast is based on historically metered generation\noutput for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector\nflows and demand from station transformers and pumped storage units.\n            \nThis API endpoint provides a maximum data output range of 1 day.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDF/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead National Demand forecast (NDF) stream
      description: "This endpoint provides the National Demand forecast received from NGESO. Data is available\ndaily and will show values for the day ahead. Expressed as an average MW\nvalue for each settlement period. The forecast is based on historically metered generation\noutput for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector\nflows and demand from station transformers and pumped storage units.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TSDF:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead Transmission System Demand forecast (TSDF)
      description: "This endpoint provides the Transmission System Demand forecast.\nData is received daily from NGESO and will show values for the day ahead.\nExpressed as an average MW value for each settlement period.\nThe Transmission System Demand forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES interconnector flows and demand from station transformers and pumped storage units.\n\nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.\n            \nThis API endpoint provides a maximum data output range of 1 day."
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TSDF/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day and day-ahead Transmission System Demand forecast (TSDF) stream
      description: 'This endpoint provides the Transmission System Demand forecast .

        Data is received daily from NGESO and will show values for the day ahead.

        Expressed as an average MW value for each settlement period.

        The Transmission System Demand forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES interconnector flows and demand from station transformers and pumped storage units.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: boundary
        in: query
        schema:
          type: string
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/WINDFOR:
    get:
      tags:
      - BMRS Datasets
      summary: Wind generation forecast (WINDFOR)
      description: 'This endpoint provides wind generation forecast data.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/WINDFOR/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Wind generation forecast (WINDFOR) stream
      description: 'This endpoint provides wind generation forecast data.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDO:
    get:
      tags:
      - BMRS Datasets
      summary: Initial National Demand outturn (INDO)
      description: "The endpoint provides data showing the initial National Demand outturn.\nData is updated at 15 min intervals containing the initial demand expressed in MW.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDOD:
    get:
      tags:
      - BMRS Datasets
      summary: Initial National Demand outturn daily (INDOD)
      description: 'This endpoint provides initial National Demand outturn daily data. The total daily energy volume is the total

        demand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding

        station transformer, pumping and interconnector export demand. It is calculated from summing the half hourly

        INDO demands (divided by two to convert to MWh).


        This API endpoint has a maximum range of 2 years (731 days).'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-26T01:00:00Z'
        example: '2023-08-26T01:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-27T01:00:00Z'
        example: '2023-08-27T01:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/INDOD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Initial National Demand outturn daily (INDOD) stream
      description: 'This endpoint provides initial National Demand outturn daily data. The total daily energy volume is the total

        demand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding

        station transformer, pumping and interconnector export demand. It is calculated from summing the half hourly

        INDO demands (divided by two to convert to MWh).


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-26T01:00:00Z'
        example: '2023-08-26T01:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-27T01:00:00Z'
        example: '2023-08-27T01:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/ITSDO:
    get:
      tags:
      - BMRS Datasets
      summary: Initial Transmission System Demand outturn (ITSDO)
      description: "The endpoint provides data showing the initial Transmission System Demand outturn.\nData is updated at 15 min intervals containing the initial demand expressed in MW.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDFD:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead National Demand and surplus forecast (NDFD)
      description: 'This endpoint provides the National Demand forecast received from NGESO.

        Data is available daily and will show values for the 2 to 14 days ahead.

        Expressed as an average MW value for each Settlement period. The forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.


        This API endpoint provides a maximum data output range of 92 days.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDFD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead National Demand and surplus forecast (NDFD) stream
      description: 'This endpoint provides the National Demand forecast received from NGESO.

        Data is available daily and will show values for the 2 to 14 days ahead.

        Expressed as an average MW value for each Settlement period. The forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES transmission losses, but EXCLUDES Interconnector flows and demand from station


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TSDFD:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead Transmission System Demand and surplus forecast (TSDFD)
      description: "This endpoint provides the Transmission System forecast. Data is available daily and will show values for the 2 to 14 days ahead.\nExpressed as an average MW value for each settlement period. The Transmission System Demand forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES interconnector flows and demand from station transformers and pumped storage units.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.\n            \nThis API endpoint provides a maximum data output range of 92 days."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TSDFD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead Transmission System Demand and surplus forecast (TSDFD) stream
      description: "This endpoint provides the Transmission System Demand forecast. Data is available daily and will show values for the 2 to 14 days ahead.\nExpressed as an average MW value for each settlement period. The Transmission System Demand forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES interconnector flows and demand from station transformers and pumped storage units.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDFW:
    get:
      tags:
      - BMRS Datasets
      summary: 2-52 weeks ahead National Demand and surplus forecast (NDFW)
      description: 'This endpoint provides the National Demand forecast received from NGESO.

        Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.

        Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.


        This API endpoint provides a maximum data output range of 366 days.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDFW/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-52 weeks ahead National Demand and surplus forecast (NDFW) stream
      description: 'This endpoint provides the National Demand forecast received from NGESO.

        Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.

        Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TSDFW:
    get:
      tags:
      - BMRS Datasets
      summary: 2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW)
      description: 'This endpoint provides the Transmission System Demand forecast received from NGESO.

        Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.

        Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.


        This API will provide a maximum data output range of 366 days.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TSDFW/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW) stream
      description: 'This endpoint provides the Transmission System Demand forecast received from NGESO.

        Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.

        Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.

        This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FREQ:
    get:
      tags:
      - BMRS Datasets
      summary: System frequency (FREQ)
      description: "The endpoint provides data that has been received every 2 minutes the transmission system frequency, expressed as a hertz value for one or more spot times within that 2 minute period.\nThe default output will be the latest published data.\n            \nA maximum limit of 24 hours is applied to this endpoint to limit response size. Use the streaming version\nfor larger response sizes."
      parameters:
      - name: measurementDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: measurementDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FREQ/stream:
    get:
      tags:
      - BMRS Datasets
      summary: System frequency (FREQ) stream
      description: 'The endpoint provides data that has been received every 2 minutes the transmission system frequency, expressed as a hertz value for one or more spot times within that 2 minute period.

        The default output will be the latest published data.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: measurementDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: measurementDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMFD:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead demand surplus forecast (OCNMFD)
      description: "The demand surplus forecast data is received hourly from NGESO.\nIt shows the daily peak half hour MW value of generating plant demand surplus for each day for the 2 to 14 days ahead.\n\nThis API endpoint provides a maximum data output range of 7 days.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMFD/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead demand surplus forecast (OCNMFD) stream
      description: 'The demand surplus forecast data is received hourly from NGESO.

        It shows the daily peak half hour MW value of generating plant demand surplus for each day for the 2 to 14 days ahead.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMFD2:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead demand margin forecast (OCNMFD2)
      description: "The demand margin forecast is received hourly from NGESO.\nIt shows the daily peak half hour MW value of generating plant demand margin for each day for the 2 to 14 days ahead.\n\nThis API endpoint provides a maximum data output range of 7 days.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMFD2/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-14 days ahead demand margin forecast (OCNMFD2) stream
      description: 'The demand margin forecast is received hourly from NGESO.

        It shows the daily peak half hour MW value of generating plant demand margin for each day for the 2 to 14 days ahead.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMF3Y:
    get:
      tags:
      - BMRS Datasets
      summary: 2-156 weeks ahead demand surplus forecast (OCNMF3Y)
      description: "The demand surplus forecast data is received hourly from NGESO.\nIt shows the weekly peak half hour MW value of generating plant demand surplus for each day for the 2-156 weeks ahead.\n\nThis API endpoint provides a maximum data output range of 7 days.\n            \nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMF3Y/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-156 weeks ahead demand surplus forecast (OCNMF3Y) stream
      description: 'The demand surplus forecast data is received hourly from NGESO.

        It shows the weekly peak half hour MW value of generating plant demand surplus for each day for the 2-156 weeks ahead.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMF3Y2:
    get:
      tags:
      - BMRS Datasets
      summary: 2-156 weeks ahead demand margin forecast (OCNMF3Y2)
      description: "The demand margin forecast is received hourly from NGESO.\nIt shows the weekly peak half hour MW value of generating plant demand margin for each day for the 2 to 156 weeks ahead.\n            \nThis API endpoint has a maximum data output range of 7 days.\n\nSpecific publish time filters may be supplied, otherwise this will retrieve the latest published forecast."
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/OCNMF3Y2/stream:
    get:
      tags:
      - BMRS Datasets
      summary: 2-156 weeks ahead demand margin forecast (OCNMF3Y2) stream
      description: 'The demand margin forecast is received hourly from NGESO.

        It shows the weekly peak half hour MW value of generating plant demand margin for each day for the 2 to 156 weeks ahead.


        Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/metadata/latest:
    get:
      tags:
      - BMRS Datasets
      summary: Returns the time when each dataset was last updated
      description: 'Depending on the dataset, this value may be taken from the timestamp on the source datafile, the

        publishTime field on the dataset, or the latest available measurement time.'
      parameters:
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/LOLPDRM:
    get:
      tags:
      - BMRS Datasets
      summary: Loss of load probability and de-rated margin (LOLPDRM)
      description: "The loss of load probability and de-rated margin data is received half-hourly from NGESO.\n            \nLoss of load probability (LoLP) is a measure of system reliability, calculated by NGESO for each settlement period,\nusing the methodology set out in the Loss of Load Probability Calculation Statement.\n            \nDe-rated margin is a forecast of the excess supply on the system, which has been adjusted to take account of the likely availability of electricity generators."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-03-06T07:00Z
        example: 2023-03-06T07:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-03-06T12:00Z
        example: 2023-03-06T12:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/LOLPDRM/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Loss of load probability and de-rated margin (LOLPDRM)
      description: "The loss of load probability and de-rated margin data is received half-hourly from NGESO.\n            \nLoss of load probability (LoLP) is a measure of system reliability, calculated by NGESO for each settlement period,\nusing the methodology set out in the Loss of Load Probability Calculation Statement.\n            \nDe-rated margin is a forecast of the excess supply on the system, which has been adjusted to take account of the likely availability of electricity generators.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-03-06T07:00Z
        example: 2023-03-06T07:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-03-06T12:00Z
        example: 2023-03-06T12:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/CDN:
    get:
      tags:
      - BMRS Datasets
      summary: Credit default notices (CDN)
      description: This endpoint provides CDN (Credit Default Notice) data received from ECVAA (Energy Contract Volume Aggregation Agent).
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-06-25T00:00:00Z'
        example: '2022-06-25T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-06-26T00:00:00Z'
        example: '2022-06-26T00:00:00Z'
      - name: bscPartyId
        in: query
        schema:
          type: string
          example: INVE
        example: INVE
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/CDN/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Credit default notices (CDN) stream
      description: "This endpoint provides CDN (Credit Default Notice) data received from ECVAA (Energy Contract Volume Aggregation Agent).\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-06-25T00:00:00Z'
        example: '2022-06-25T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-06-26T00:00:00Z'
        example: '2022-06-26T00:00:00Z'
      - name: bscPartyId
        in: query
        schema:
          type: string
          example: INVE
        example: INVE
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SYSWARN:
    get:
      tags:
      - BMRS Datasets
      summary: System warnings (SYSWARN)
      description: This endpoint provides system warnings data
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: 2023/06/01 07:00
        example: 2023/06/01 07:00
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: 2023/06/30 10:00
        example: 2023/06/30 10:00
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SYSWARN/stream:
    get:
      tags:
      - BMRS Datasets
      summary: System warnings (SYSWARN) stream
      description: 'This endpoint provides system warnings data


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: 2023/06/01 07:00
        example: 2023/06/01 07:00
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: 2023/06/30 10:00
        example: 2023/06/30 10:00
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DCI:
    get:
      tags:
      - BMRS Datasets
      summary: Demand control instructions (DCI)
      description: This endpoint provides demand control instruction data, filtered by publish time.
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: 2021-04-30T00:00Z
        example: 2021-04-30T00:00Z
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: 2021-05-30T20:00Z
        example: 2021-05-30T20:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DCI/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Demand control instructions (DCI) stream
      description: 'This endpoint provides demand control instruction data, filtered by publish time.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        schema:
          type: string
          format: date-time
          example: 2021-04-30T00:00Z
        example: 2021-04-30T00:00Z
      - name: publishDateTimeTo
        in: query
        schema:
          type: string
          format: date-time
          example: 2021-05-30T20:00Z
        example: 2021-05-30T20:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SOSO:
    get:
      tags:
      - BMRS Datasets
      summary: SO-SO prices (SOSO)
      description: 'This endpoint provides system operator to system operator prices data, filtered by publish time.

        This API endpoint has a maximum range of 24 hours.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-26T07:00:00Z'
        example: '2023-09-26T07:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-27T07:00:00Z'
        example: '2023-09-27T07:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SOSO/stream:
    get:
      tags:
      - BMRS Datasets
      summary: SO-SO prices (SOSO) stream
      description: 'This endpoint provides system operator to system operator prices data, filtered by publish time.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-26T07:00:00Z'
        example: '2023-09-26T07:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-27T07:00:00Z'
        example: '2023-09-27T07:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TUDM:
    get:
      tags:
      - BMRS Datasets
      summary: Trading unit data (S0491_TUDM)
      description: This endpoint provides trading unit data for a settlement period filtered by trading unit name and type.
      parameters:
      - name: settlementDate
        in: query
        description: The settlement date to filter. This must be in the format yyyy-MM-dd.
        required: true
        schema:
          type: string
          format: date
          example: '2023-10-05'
        example: '2023-10-05'
      - name: settlementPeriod
        in: query
        required: true
        schema:
          type: integer
          format: int32
          example: 10
        example: 10
      - name: tradingUnitName
        in: query
        schema:
          type: array
          items:
            type: string
          example:
          - DEFAULT__A
        example:
        - DEFAULT__A
      - name: tradingUnitType
        in: query
        schema:
          enum:
          - Base
          - Sole
          - Others
          type: string
          example: Base
        example: Base
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/TUDM/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Trading unit data (S0491_TUDM) stream
      description: '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.'
      parameters:
      - name: settlementDateFrom
        in: query
        description: The settlement date to filter from. This must be in the format yyyy-MM-dd.
        required: true
        schema:
          type: string
          format: date
          example: '2023-10-05'
        example: '2023-10-05'
      - name: settlementPeriodFrom
        in: query
        required: true
        schema:
          type: integer
          format: int32
          example: 10
        example: 10
      - name: settlementDateTo
        in: query
        description: The settlement date to filter to. This must be in the format yyyy-MM-dd.
        required: true
        schema:
          type: string
          format: date
          example: '2023-10-05'
        example: '2023-10-05'
      - name: settlementPeriodTo
        in: query
        required: true
        schema:
          type: integer
          format: int32
          example: 11
        example: 11
      - name: tradingUnitName
        in: query
        schema:
          type: array
          items:
            type: string
          example:
          - DEFAULT__A
        example:
        - DEFAULT__A
      - name: tradingUnitType
        in: query
        schema:
          enum:
          - Base
          - Sole
          - Others
          type: string
          example: Base
        example: Base
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RZDF:
    get:
      tags:
      - BMRS Datasets
      summary: Restoration Region Demand Forecast (RZDF)
      description: 'This endpoint provides the forecasted peak demand values (60% and 100%) for each restoration region with filtering by submission time, region, and GSP Group ID (when received by NESO).

        This API endpoint supports up to 12 months range per request.'
      parameters:
      - name: submissionDateTimeFrom
        in: query
        description: The submission date and time to filter from. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-06-25 00:00:00Z'
        example: '2025-06-25 00:00:00Z'
      - name: submissionDateTimeTo
        in: query
        description: The submission date and time to filter to. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-07-05 00:00:00Z'
        example: '2025-07-05 00:00:00Z'
      - name: region
        in: query
        description: The region to filter by.
        schema:
          enum:
          - North Scotland
          - South Scotland
          - North West
          - North East
          - Midlands
          - South West
          - South East
          type: string
      - name: gspGroupId
        in: query
        description: The GSP Group ID to filter by.
        schema:
          type: string
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RZDF/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Restoration Region Demand Forecast (RZDF) stream
      description: 'This endpoint provides the forecasted peak demand values (60% and 100%) for each restoration region with filtering by submission time, region, and GSP Group ID (when received by NESO).

        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: submissionDateTimeFrom
        in: query
        description: The submission date and time to filter from. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-06-25 00:00:00Z'
        example: '2025-06-25 00:00:00Z'
      - name: submissionDateTimeTo
        in: query
        description: The submission date and time to filter to. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-07-05 00:00:00Z'
        example: '2025-07-05 00:00:00Z'
      - name: region
        in: query
        description: The region to filter by.
        schema:
          enum:
          - North Scotland
          - South Scotland
          - North West
          - North East
          - Midlands
          - South West
          - South East
          type: string
      - name: gspGroupId
        in: query
        description: The GSP Group ID to filter by.
        schema:
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RZDR:
    get:
      tags:
      - BMRS Datasets
      summary: Restoration Region Demand Restored (RZDR)
      description: 'This endpoint provides the restored demand value for each restoration region with filtering by submission time, region, and GSP Group ID (when received by NESO).

        This API endpoint supports up to 12 months range per request.'
      parameters:
      - name: submissionDateTimeFrom
        in: query
        description: The submission date and time to filter from. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-06-25 00:00:00Z'
        example: '2025-06-25 00:00:00Z'
      - name: submissionDateTimeTo
        in: query
        description: The submission date and time to filter to. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-07-05 00:00:00Z'
        example: '2025-07-05 00:00:00Z'
      - name: region
        in: query
        description: The region to filter by.
        schema:
          enum:
          - North Scotland
          - South Scotland
          - North West
          - North East
          - Midlands
          - South West
          - South East
          type: string
      - name: gspGroupId
        in: query
        description: The GSP Group ID to filter by.
        schema:
          type: string
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RZDR/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Restoration Region Demand Restored (RZDR) Stream
      description: 'This endpoint provides the restored demand value for each restoration region with filtering by submission time, region, and GSP Group ID (when received by NESO).

        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: submissionDateTimeFrom
        in: query
        description: The submission date and time to filter from. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-06-25 00:00:00Z'
        example: '2025-06-25 00:00:00Z'
      - name: submissionDateTimeTo
        in: query
        description: The submission date and time to filter to. This should be in the format yyyy-MM-dd HH:mm:ssZ.
        required: true
        schema:
          type: string
          format: date-time
          example: '2025-07-05 00:00:00Z'
        example: '2025-07-05 00:00:00Z'
      - name: region
        in: query
        description: The region to filter by.
        schema:
          enum:
          - North Scotland
          - South Scotland
          - North West
          - North East
          - Midlands
          - South West
          - South East
          type: string
      - name: gspGroupId
        in: query
        description: The GSP Group ID to filter by.
        schema:
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SIL:
    get:
      tags:
      - BMRS Datasets
      summary: Stable Import Limit (SIL)
      description: "This endpoint provides Stable Import Limit data received from NGESO.\nStable Import Limit is a negative megawatt value, expressing the minimum stable operating level at which a particular BM Unit can import power from the transmission system.\n            \nIf no date window is chosen, the search will default to results from last 24 hours."
      parameters:
      - name: from
        in: query
        description: The start of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-20T13:15Z
        example: 2022-07-20T13:15Z
      - name: to
        in: query
        description: The end of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-21T13:15Z
        example: 2022-07-21T13:15Z
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_KILLPG-1
        example:
        - T_KILLPG-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SIL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Stable Import Limit (SIL) stream
      description: "This endpoint provides Stable Import Limit data received from NGESO.\nStable Import Limit is a negative megawatt value, expressing the minimum stable operating level at which a particular BM Unit can import power from the transmission system.\n            \nIf no date window is chosen, the search will default to results from last 24 hours.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for SIL data."
      parameters:
      - name: from
        in: query
        description: The start of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-20T13:15Z
        example: 2022-07-20T13:15Z
      - name: to
        in: query
        description: The end of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-21T13:15Z
        example: 2022-07-21T13:15Z
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_KILLPG-1
        example:
        - T_KILLPG-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SEL:
    get:
      tags:
      - BMRS Datasets
      summary: Stable Export Limit (SEL)
      description: "This endpoint provides Stable Export Limit data received from NGESO.\nStable Export Limit is a positive megawatt value, expressing the minimum stable operating level at which a particular BM Unit can export power to the transmission system.\n            \nIf no date window is chosen, the search will default to results from last 24 hours."
      parameters:
      - name: from
        in: query
        description: The start of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-20T13:15Z
        example: 2022-07-20T13:15Z
      - name: to
        in: query
        description: The end of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-21T13:15Z
        example: 2022-07-21T13:15Z
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_KILLPG-1
        example:
        - T_KILLPG-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/SEL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Stable Export Limit (SEL) stream
      description: "This endpoint provides Stable Export Limit data received from NGESO.\nStable Export Limit is a positive megawatt value, expressing the minimum stable operating level at which a particular BM Unit can export power to the transmission system.\n            \nIf no date window is chosen, the search will default to results from last 24 hours.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for SEL data."
      parameters:
      - name: from
        in: query
        description: The start of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-20T13:15Z
        example: 2022-07-20T13:15Z
      - name: to
        in: query
        description: The end of the data time window.
        schema:
          type: string
          format: date-time
          example: 2022-07-21T13:15Z
        example: 2022-07-21T13:15Z
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_KILLPG-1
        example:
        - T_KILLPG-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MZT:
    get:
      tags:
      - BMRS Datasets
      summary: Minimum Zero Time (MZT)
      description: "This endpoint provides Minimum Zero Time data received from NGESO.\n\nThe Minimum Zero Time is the minimum time that a BM Unit which has been exporting must operate at zero or import, before returning to export;\nwhereas if the BM Unit has been importing, the MZT indicates the minimum time that it must operate at zero or export before returning to import,\nif action by the System Operator (i.e. a Bid-Offer Acceptance) places it at such a level.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MZT/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Minimum Zero Time (MZT) stream
      description: "This endpoint provides Minimum Zero Time data received from NGESO.\n\nThe Minimum Zero Time is the minimum time that a BM Unit which has been exporting must operate at zero or import, before returning to export;\nwhereas if the BM Unit has been importing, the MZT indicates the minimum time that it must operate at zero or export before returning to import,\nif action by the System Operator (i.e. a Bid-Offer Acceptance) places it at such a level.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \n  /// All Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MZT data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MNZT:
    get:
      tags:
      - BMRS Datasets
      summary: Minimum Non-Zero Time (MNZT)
      description: "This endpoint provides Minimum Non Zero Time data received from NGESO.\n\nThe Minimum Non-Zero Time represents the minimum time that a BM Unit can operate at a non-zero level as a result of a Bid-Offer Acceptance.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MNZT/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Minimum Non-Zero Time (MNZT) stream
      description: "This endpoint provides Minimum Non Zero Time data received from NGESO.\n\nThe Minimum Non-Zero Time represents the minimum time that a BM Unit can operate at a non-zero level as a result of a Bid-Offer Acceptance.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MNZT data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MDV:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Delivery Volume (MDV)
      description: "This endpoint provides Maximum Delivery Volume data received from NGESO.\n            \nMaximum Delivery Volume is the maximum number of MWh of Offer (or Bid), that a particular BM Unit\nmay deliver within the associated Maximum Delivery Period.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MDV/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Delivery Volume (MDV) stream
      description: "This endpoint provides Maximum Delivery Volume data received from NGESO.\n            \nMaximum Delivery Volume is the maximum number of MWh of Offer (or Bid), that a particular BM Unit\nmay deliver within the associated Maximum Delivery Period.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MDV data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MDP:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Delivery Period (MDP)
      description: "Maximum Delivery Period (MDP) is the maximum period, expressed in minutes, over which the\nMaximum Delivery Volume (MDV) applies. Maximum Delivery Volume is the maximum number of MWh of Offer (or Bid)\nthat a particular BM Unit may deliver within the associated Maximum Delivery Period.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MDP/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Maximum Delivery Period (MDP) stream
      description: "This endpoint provides Maximum Delivery Period data received from NGESO.\n            \nMaximum Delivery Period (MDP) is the maximum period over which the Maximum Delivery Volume (MDV) applies.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for MDP data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NTB:
    get:
      tags:
      - BMRS Datasets
      summary: Notice to Deliver Bids (NTB)
      description: "This endpoint provides Notice to Deliver Bids data received from NGESO.\n            \nNotice to Deliver Bids (NTB) indicates the length of time between the issuing of a Bid-Offer Acceptance and the\ntime when a BM Unit begins to deliver Bid volumes, expressed in minutes.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NTB/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Notice to Deliver Bids (NTB) stream
      description: "This endpoint provides Notice to Deliver Bids data received from NGESO.\n            \nNotice to Deliver Bids (NTB) indicates the length of time between the issuing of a Bid-Offer Acceptance and the\ntime when a BM Unit begins to deliver Bid volumes, expressed in minutes.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for NTB data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NTO:
    get:
      tags:
      - BMRS Datasets
      summary: Notice to Deliver Offers (NTO)
      description: "This endpoint provides Notice to Deliver Offers data received from NGESO.\n            \nNotice to Deliver Offers (NTO) indicates the length of time required for a BM Unit to start delivering Offers\nfrom the time that the Bid-Offer Acceptance is issued, expressed in minutes.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NTO/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Notice to Deliver Offers (NTO) stream
      description: "This endpoint provides Notice to Deliver Offers data received from NGESO.\n            \nNotice to Deliver Offers (NTO) indicates the length of time required for a BM Unit to start delivering Offers\nfrom the time that the Bid-Offer Acceptance is issued, expressed in minutes.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for NTO data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDZ:
    get:
      tags:
      - BMRS Datasets
      summary: Notice to Deviate from Zero (NDZ)
      description: "This endpoint provides Notice to Deviate from Zero data received from NGESO.\n            \nNotice to Deviate from Zero (NDZ) indicates the length of time required for a BM Unit to start importing or\nexporting energy, from a zero Physical Notification level as a result of a Bid-Offer Acceptance, expressed in\nminutes.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/NDZ/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Notice to Deviate from Zero (NDZ) stream
      description: "This endpoint provides Notice to Deviate from Zero data received from NGESO.\n            \nNotice to Deviate from Zero (NDZ) indicates the length of time required for a BM Unit to start importing or\nexporting energy, from a zero Physical Notification level as a result of a Bid-Offer Acceptance, expressed in\nminutes.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for NDZ data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RURE:
    get:
      tags:
      - BMRS Datasets
      summary: Run Up Rate Export (RURE)
      description: "This endpoint provides Run Up Rate Export data received from NGESO.\n            \nRun Up Rate Export (RURE) expresses the rate of increase in active power production (MW/minute)\nfor a particular BM Unit which is exporting power within a particular operating range.\nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RURE/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Run Up Rate Export (RURE) stream
      description: "This endpoint provides Run Up Rate Export data received from NGESO.\n            \nRun Up Rate Export (RURE) expresses the rate of increase in active power production (MW/minute)\nfor a particular BM Unit which is exporting power within a particular operating range.\nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RDRE:
    get:
      tags:
      - BMRS Datasets
      summary: Run Down Rate Export (RDRE)
      description: "This endpoint provides Run Down Rate Export data received from NGESO.\n            \nRun Down Rate Export (RDRE) expresses the rate of decrease in active power production (MW/minute)\nfor a particular BM Unit which is exporting power within a particular operating range. \nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RDRE/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Run Down Rate Export (RDRE) stream
      description: "This endpoint provides Run Down Rate Export data received from NGESO.\n            \nRun Down Rate Export (RDRE) expresses the rate of decrease in active power production (MW/minute)\nfor a particular BM Unit which is exporting power within a particular operating range. \nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RURI:
    get:
      tags:
      - BMRS Datasets
      summary: Run Up Rate Import (RURI)
      description: "This endpoint provides Run Up Rate Import data received from NGESO.\n            \nRun Up Rate Import (RURI) expresses the rate of decrease in active power consumption (MW/minute)\nfor a particular BM Unit which is importing power within a particular operating range.\nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RURI/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Run Up Rate Import (RURI) stream
      description: "This endpoint provides Run Up Rate Import data received from NGESO.\n            \nRun Up Rate Import (RURI) expresses the rate of decrease in active power consumption (MW/minute)\nfor a particular BM Unit which is importing power within a particular operating range. \nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RDRI:
    get:
      tags:
      - BMRS Datasets
      summary: Run Down Rate Import (RDRI)
      description: "This endpoint provides Run Down Rate Import data received from NGESO.\n            \nRun Down Rate Import (RDRI) expresses the rate of increase in active power consumption (MW/minute)\nfor a particular BM Unit which is importing power within a particular operating range.\nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1"
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/RDRI/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Run Down Rate Import (RDRI) stream
      description: "This endpoint provides Run Down Rate Import data received from NGESO.\n            \nRun Down Rate Import (RDRI) expresses the rate of increase in active power consumption (MW/minute)\nfor a particular BM Unit which is importing power within a particular operating range. \nThere can be up to three of these for a given BM Unit.\n            \nBy default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or\nsettlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement\ndate, allowing for searching by a combination of time and/or settlement date & settlement period.\nNote: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For\nexample, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.\n            \nAll Dates and DateTimes should be expressed as defined within\n<a href=\"https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target=\"_blank\">RFC 3339</a>.\n            \nSome examples of date parameter combinations are shown below.\n            \nFiltering from start time to start time:\n            \n    /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n            \nFiltering from start time to settlement date and period:\n            \n    /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n            \nFiltering from settlement date and period to start time:\n            \n    /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1\n            \nFiltering from settlement date and period to settlement date and period:\n            \n    /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-01T00:00Z
        example: 2022-08-01T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-02T00:00Z
        example: 2022-08-02T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        description: The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.
        schema:
          type: array
          items:
            type: string
          example:
          - T_FOYE-1
        example:
        - T_FOYE-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/REMIT:
    get:
      tags:
      - BMRS Datasets
      summary: The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT)
      description: "The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) is an EU regulation aimed at preventing market abuse in wholesale energy markets.\n\nThis endpoint returns information provided by market participants to comply with Article 4 of Regulation on Wholesale Energy Market Integrity and Transparency (REMIT) Regulation (EU) 1227/2011.\n            \nOnly JSON and XML formats are supported for this endpoint."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/04/13 07:00
        example: 2023/04/13 07:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/04/13 10:00
        example: 2023/04/13 10:00
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/REMIT/stream:
    get:
      tags:
      - BMRS Datasets
      summary: The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) stream
      description: 'The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) is an EU regulation aimed at preventing market abuse in wholesale energy markets.


        This endpoint returns information provided by market participants to comply with Article 4 of Regulation on Wholesale Energy Market Integrity and Transparency (REMIT) Regulation (EU) 1227/2011.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/04/13 07:00
        example: 2023/04/13 07:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/04/13 10:00
        example: 2023/04/13 10:00
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/AGWS:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630)
      description: "This endpoint provides actual or estimated wind and solar power generation\nper settlement period. It returns generation with Power System Resource type\nSolar, Wind Onshore or Wind Offshore (Fuel Type categories as defined by\nCommission Regulation (EU) No 543/2013).\n            \nThis API endpoint provides a maximum data output range of 7 days."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-27T10:00:00Z'
        example: '2023-07-27T10:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-28T10:00:00Z'
        example: '2023-07-28T10:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/AGWS/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630) stream
      description: "This endpoint provides actual or estimated wind and solar power generation\nper settlement period. It returns generation with Power System Resource type\nSolar, Wind Onshore or Wind Offshore (Fuel Type categories as defined by\nCommission Regulation (EU) No 543/2013).\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-27T10:00:00Z'
        example: '2023-07-27T10:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-28T10:00:00Z'
        example: '2023-07-28T10:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DGWS:
    get:
      tags:
      - BMRS Datasets
      summary: Day-Ahead Generation For Wind And Solar (DGWS / B1440)
      description: 'This endpoint provides day-ahead generation data for wind and solar.


        This API endpoint provides a maximum data output range of 7 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/18 07:00
        example: 2023/07/18 07:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/21 10:00
        example: 2023/07/21 10:00
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DGWS/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day-Ahead Generation For Wind And Solar (DGWS / B1440) stream
      description: "This endpoint provides day-ahead generation data for wind and solar.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/18 07:00
        example: 2023/07/18 07:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/21 10:00
        example: 2023/07/21 10:00
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/AGPT:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Aggregated Generation Per Type (AGPT / B1620)
      description: "This endpoint provides actual generation data per settlement period aggregated by Power System Resource type (Fuel Type categories as defined by Commission Regulation (EU) No 543/2013).\n            \nThis endpoint filters by publishTime and provides a maximum data output range of 4 days."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-18 18:00
        example: 2023-07-18 18:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-21 09:00
        example: 2023-07-21 09:00
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/AGPT/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Aggregated Generation Per Type (AGPT / B1620) stream
      description: "This endpoint provides actual generation data per settlement period aggregated by Power System Resource type (Fuel Type categories as defined by Commission Regulation (EU) No 543/2013).\n            \nThis endpoint filters by publishTime and has an optimised JSON payload aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-18 18:00
        example: 2023-07-18 18:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-21 09:00
        example: 2023-07-21 09:00
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/B1610:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Generation Output Per Generation Unit (B1610)
      description: "This endpoint provides the actual metered volume output (MWh) per Settlement Period for all BM units (Positive, Negative or zero MWh values).\n            \nThe settlement period to query must be specified as a date and settlement period. The date must be given in the format yyyy-MM-dd.\n            \nThe information is published five days after the end of the operational period based on the Interim Information (II) Settlement Run and the data is refreshed by subsequent Settlement Runs.\n            \nThe generation output returned by this endpoint is the metered volume and not the instantaneous power output as often appears in other specifications."
      parameters:
      - name: settlementDate
        in: query
        required: true
        schema:
          type: string
          format: date
          example: '2022-08-12'
        example: '2022-08-12'
      - name: settlementPeriod
        in: query
        required: true
        schema:
          type: integer
          format: int32
          example: 10
        example: 10
      - name: bmUnit
        in: query
        schema:
          type: array
          items:
            type: string
          example:
          - T_CNQPS-1
        example:
        - T_CNQPS-1
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/B1610/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Generation Output Per Generation Unit (B1610) stream
      description: "This endpoint provides the actual metered volume output (MWh) per Settlement Period for all BM units (Positive, Negative or zero MWh values).\n            \nThe information is published five days after the end of the operational period based on the Interim Information (II) Settlement Run and the data is refreshed by subsequent Settlement Runs.\n            \nThe generation output returned by this endpoint is the metered volume and not the instantaneous power output as often appears in other specifications.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: from
        in: query
        description: The "from" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-12T00:00Z
        example: 2022-08-12T00:00Z
      - name: to
        in: query
        description: The "to" start time or settlement date for the filter.
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-08-14T00:00Z
        example: 2022-08-14T00:00Z
      - name: settlementPeriodFrom
        in: query
        description: The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: settlementPeriodTo
        in: query
        description: The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.
        schema:
          type: integer
          format: int32
      - name: bmUnit
        in: query
        schema:
          type: array
          items:
            type: string
          example:
          - T_CNQPS-1
        example:
        - T_CNQPS-1
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/IGCA:
    get:
      tags:
      - BMRS Datasets
      summary: Installed Generation Capacity Aggregated (IGCA / B1410)
      description: 'This endpoint provides installed generation capacity aggregated data.


        This API endpoint provides a maximum data output range of 2 years (731 days).'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-04-20T00:00:00Z'
        example: '2022-04-20T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-04-27T00:00:00Z'
        example: '2022-04-27T00:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/IGCA/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Installed Generation Capacity Aggregated (IGCA / B1410) stream
      description: "This endpoint provides installed generation capacity aggregated data.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-04-20T00:00:00Z'
        example: '2022-04-20T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2022-04-27T00:00:00Z'
        example: '2022-04-27T00:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/IGCPU:
    get:
      tags:
      - BMRS Datasets
      summary: Installed Generation Capacity per Unit (IGCPU / B1420)
      description: "This endpoint provides information about production units (existing and planned)\nwith an installed generation capacity equaling to or exceeding 100 MW. \n            \nThe database was populated from a data dump lacking publishTime values,\nall entries were assigned a default publishTime of 2023-01-01 00:00 during the migration.\n\nThis API endpoint provides a maximum data output range of 2 years (731 days)."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        example: '2023-01-01T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2024-01-02T00:00:00Z'
        example: '2024-01-02T00:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/IGCPU/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Installed Generation Capacity per Unit (IGCPU / B1420) stream
      description: "This endpoint provides information about production units (existing and planned)\nwith an installed generation capacity equaling to or exceeding 100 MW. \n            \nThe database was populated from a data dump lacking publishTime values,\nall entries were assigned a default publishTime of 2023-01-01 00:00 during the migration.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        example: '2023-01-01T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2024-01-02T00:00:00Z'
        example: '2024-01-02T00:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/ATL:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Total Load Per Bidding Zone (ATL / B0610)
      description: 'This endpoint provides actual total load per bidding zone data.


        This API endpoint provides a maximum data output range of 7 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-18T07:00:00Z'
        example: '2023-07-18T07:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-21T10:00:00Z'
        example: '2023-07-21T10:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/ATL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Actual Total Load Per Bidding Zone (ATL / B0610) stream
      description: "This endpoint provides actual total load per bidding zone data.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-18T07:00:00Z'
        example: '2023-07-18T07:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-07-21T10:00:00Z'
        example: '2023-07-21T10:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DATL:
    get:
      tags:
      - BMRS Datasets
      summary: Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620)
      description: 'This endpoint provides day-ahead total load forecast per bidding zone data.


        This API endpoint provides a maximum data output range of 7 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/18 07:00
        example: 2023/07/18 07:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/21 10:00
        example: 2023/07/21 10:00
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DATL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620) stream
      description: 'This endpoint provides day-ahead total load forecast per bidding zone data.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/18 07:00
        example: 2023/07/18 07:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023/07/21 10:00
        example: 2023/07/21 10:00
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/WATL:
    get:
      tags:
      - BMRS Datasets
      summary: Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630)
      description: 'This endpoint provides week-ahead total load forecast per bidding zone data with minimum possible

        and maximum available loads provided in MW values.


        This API endpoint has a maximum range of 367 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/WATL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630) stream
      description: 'This endpoint provides week-ahead total load forecast per bidding zone data with minimum possible

        and maximum available loads provided in MW values.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DAG:
    get:
      tags:
      - BMRS Datasets
      summary: Day-Ahead Aggregated Generation (DAG / B1430)
      description: "This endpoint provides day-ahead aggregated generation data.\n            \nIt has a maximum date range of 7 days."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-18 18:00
        example: 2023-07-18 18:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-21 09:00
        example: 2023-07-21 09:00
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/DAG/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Day-Ahead Aggregated Generation (DAG / B1430) stream
      description: "This endpoint provides day-ahead aggregated generation data.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-18 18:00
        example: 2023-07-18 18:00
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-07-21 09:00
        example: 2023-07-21 09:00
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MATL:
    get:
      tags:
      - BMRS Datasets
      summary: Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640)
      description: 'This endpoint provides month-ahead total load per bidding zone forecast data with minimum possible

        and maximum available loads provided in MW values.


        This API endpoint has a maximum range of 367 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/MATL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640) stream
      description: 'This endpoint provides month-ahead total load per bidding zone forecast data with minimum possible

        and maximum available loads provided in MW values.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/YATL:
    get:
      tags:
      - BMRS Datasets
      summary: Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650)
      description: 'This endpoint provides year-ahead total load per bidding zone forecast data with minimum possible

        and maximum available loads provided in MW values.


        This API endpoint has a maximum range of 367 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/YATL/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650) stream
      description: 'This endpoint provides year-ahead total load per bidding zone forecast data with minimum possible

        and maximum available loads provided in MW values.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/CCM:
    get:
      tags:
      - BMRS Datasets
      summary: Cost of Congestion Management (CCM / B1330)
      description: 'This endpoint provides cost of congestion management data.


        This API endpoint has a maximum range of 2 years (731 days).'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/CCM/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Cost of Congestion Management (CCM / B1330) stream
      description: 'This endpoint provides cost of congestion management data.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-06-25T00:00Z
        example: 2022-06-25T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/YAFM:
    get:
      tags:
      - BMRS Datasets
      summary: Year Ahead Forecast Margin (YAFM / B0810)
      description: "This endpoint provides year-ahead forecast margin data.\n            \nA year-ahead forecast margin is defined as the difference between yearly forecast of available generation capacity and yearly forecast of total load,\ntaking into account the forecast of total generation capacity, forecast of availability of generation and forecast of reserves contracted for system services.\n\nThis API endpoint has a maximum range of 20 years (7305 days)."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2021-06-01T00:00Z
        example: 2021-06-01T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/YAFM/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Year Ahead Forecast Margin (YAFM / B0810) stream
      description: "This endpoint provides year-ahead forecast margin data.\n\nA year-ahead forecast margin is defined as the difference between yearly forecast of available generation capacity and yearly forecast of total load,\ntaking into account the forecast of total generation capacity, forecast of availability of generation and forecast of reserves contracted for system services.\n            \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data."
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2021-06-01T00:00Z
        example: 2021-06-01T00:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2022-07-25T00:00Z
        example: 2022-07-25T00:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/ABUC:
    get:
      tags:
      - BMRS Datasets
      summary: Amount Of Balancing Reserves Under Contract (ABUC / B1720)
      description: 'This endpoint provides amount of balancing reserves under contract data.


        This API endpoint has a maximum range of 2 years (731 days).'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-22T01:00:00Z'
        example: '2023-08-22T01:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-23T01:00:00Z'
        example: '2023-08-23T01:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/ABUC/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Amount Of Balancing Reserves Under Contract (ABUC / B1720) stream
      description: 'This endpoint provides amount of balancing reserves under contract data.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-22T01:00:00Z'
        example: '2023-08-22T01:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-08-23T01:00:00Z'
        example: '2023-08-23T01:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/PPBR:
    get:
      tags:
      - BMRS Datasets
      summary: Prices Of Procured Balancing Reserves (PPBR / B1730)
      description: 'This endpoint provides prices of procured balancing reserves.


        This API endpoint has a maximum range of 2 years (731 days).'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-12T01:00:00Z'
        example: '2023-09-12T01:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-17T01:00:00Z'
        example: '2023-09-17T01:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/PPBR/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Prices Of Procured Balancing Reserves (PPBR / B1730) stream
      description: 'This endpoint provides prices of procured balancing reserves.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-12T01:00:00Z'
        example: '2023-09-12T01:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-17T01:00:00Z'
        example: '2023-09-17T01:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FEIB:
    get:
      tags:
      - BMRS Datasets
      summary: Financial Expenses and Income for Balancing (FEIB / B1790)
      description: 'This endpoint provides financial expenses and income for balancing data.


        This API endpoint has a maximum range of 1 year (367 days).'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-10-12 01:00Z
        example: 2023-10-12 01:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-11-12 01:00Z
        example: 2023-11-12 01:00Z
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/FEIB/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Financial Expenses and Income for Balancing (FEIB / B1790) stream
      description: 'This endpoint provides financial expenses and income for balancing data.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-10-12 01:00Z
        example: 2023-10-12 01:00Z
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: 2023-11-12 01:00Z
        example: 2023-11-12 01:00Z
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/AOBE:
    get:
      tags:
      - BMRS Datasets
      summary: Accepted Offered Balancing Energy (AOBE)
      description: 'This endpoint provides accepted offered balancing energy data.


        This API endpoint has a maximum range of 7 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-11-06T00:00:00Z'
        example: '2023-11-06T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-11-13T00:00:00Z'
        example: '2023-11-13T00:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/AOBE/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Accepted Offered Balancing Energy (AOBE) stream
      description: 'This endpoint provides accepted offered balancing energy data.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-11-06T00:00:00Z'
        example: '2023-11-06T00:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-11-13T00:00:00Z'
        example: '2023-11-13T00:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/BEB:
    get:
      tags:
      - BMRS Datasets
      summary: Balancing Energy Bids (BEB)
      description: 'This endpoint provides information on all balancing energy bids, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.b.


        This API endpoint has a maximum range of 7 days.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-10-30T14:00:00Z'
        example: '2023-10-30T14:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-10-30T15:00:00Z'
        example: '2023-10-30T15:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/BEB/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Balancing Energy Bids (BEB) stream
      description: 'This endpoint provides information on all balancing energy bids, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.b.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-10-30T14:00:00Z'
        example: '2023-10-30T14:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-10-30T15:00:00Z'
        example: '2023-10-30T15:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/CBS:
    get:
      tags:
      - BMRS Datasets
      summary: Current Balancing State (CBS)
      description: 'This endpoint provides information on the current system balance, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.a.


        This API endpoint has a maximum range of 1 day.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-11T14:00:07.00Z'
        example: '2023-09-11T14:00:07.00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-11T14:31:07.00Z'
        example: '2023-09-11T14:31:07.00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/CBS/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Current Balancing State (CBS) stream
      description: 'This endpoint provides information on the current system balance, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.a.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-11T14:00:07.00Z'
        example: '2023-09-11T14:00:07.00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2023-09-11T14:31:07.00Z'
        example: '2023-09-11T14:31:07.00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/PBC:
    get:
      tags:
      - BMRS Datasets
      summary: Procured Balancing Capacity (PBC)
      description: 'This endpoint provides information on the procured balancing capacity, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.f.


        This API endpoint has a maximum range of 1 day.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2024-02-09T14:00:00Z'
        example: '2024-02-09T14:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2024-02-10T14:00:00Z'
        example: '2024-02-10T14:00:00Z'
      - name: format
        in: query
        description: Response data format. Use json/xml to include metadata.
        schema:
          enum:
          - json
          - xml
          - csv
          type: string
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            application/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            text/json:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            text/csv:
              schema:
                $ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
  /datasets/PBC/stream:
    get:
      tags:
      - BMRS Datasets
      summary: Procured Balancing Capacity (PBC) stream
      description: 'This endpoint provides information on the procured balancing capacity, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.f.


        This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.'
      parameters:
      - name: publishDateTimeFrom
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2024-02-09T14:00:00Z'
        example: '2024-02-09T14:00:00Z'
      - name: publishDateTimeTo
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2024-02-10T14:00:00Z'
        example: '2024-02-10T14:00:00Z'
      responses:
        '200':
          description: Data retrieved
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
        '429':
          description: Too many requests
        '400':
          description: Error with query parameters - see response for details
        '500':
          description: Server error - please try again later
components:
  schemas:
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: AGWS
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-AGWS-20810714
        documentRevisionNumber:
          type: integer
          format: int32
          example: 2
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        businessType:
          type: string
          nullable: true
          example: Solar generation
        psrType:
          type: string
          nullable: true
          example: Solar
        quantity:
          type: number
          format: double
          example: 1829
        startTime:
          type: string
          format: date-time
          example: '2023-07-12 06:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2022-07-12'
        settlementPeriod:
          type: integer
          format: int32
          example: 16
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        fuelType:
          type: string
          nullable: true
          example: WIND
        nationalGridBmUnit:
          type: string
          nullable: true
          example: WTMSO-1
        bmUnit:
          type: string
          nullable: true
          example: T_WTMSO-1
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: '2022-08-15T11:00:00Z'
        forecastDate:
          type: string
          format: date
          example: '2022-08-17'
        outputUsable:
          type: integer
          format: int64
          nullable: true
          example: 84
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: SOSO
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: 2022-09-20T00:00Z
        senderIdentification:
          type: string
          nullable: true
          example: 10X1001A1001A515
        receiverIdentification:
          type: string
          nullable: true
          example: 10X1001A1001A59Q
        contractIdentification:
          type: string
          nullable: true
          example: EG_20210928_1100_1
        resourceProvider:
          type: string
          nullable: true
          example: EG_20210928_1100_1
        tradeDirection:
          type: string
          nullable: true
          example: A02
        tradeQuantity:
          type: number
          format: double
          example: 25
        tradePrice:
          type: number
          format: double
          example: 30.4
        traderUnit:
          type: string
          nullable: true
          example: EWIC_EG
        startTime:
          type: string
          format: date-time
          example: 2023-09-25 18:30
        endTime:
          type: string
          format: date-time
          example: 2023-09-20 18:30
        settlementDate:
          type: string
          format: date
          example: '2023-01-31'
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: QAS
        settlementDate:
          type: string
          format: date
          example: '2022-07-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        bmUnitApplicableBalancingServicesVolume:
          type: number
          format: double
          example: 123.45
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: PBC
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-PBC-00688983
        timeSeriesId:
          type: string
          nullable: true
          example: NGET-EMFIP-PBC-TS-36758603
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-08-22T07:43:04Z'
        flowDirection:
          type: string
          nullable: true
          example: Up
        psrType:
          type: string
          nullable: true
          example: Generation
        quantity:
          type: number
          format: double
          example: 1140
        procurementPrice:
          type: number
          format: double
          example: 150
        startTime:
          type: string
          format: date-time
          example: '2023-08-22T07:43:04Z'
        settlementDate:
          type: string
          format: date
          example: '2023-08-23'
        settlementPeriod:
          type: integer
          format: int32
          example: 1
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        fuelType:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
          nullable: true
        systemZone:
          type: string
          nullable: true
        calendarWeekNumber:
          type: integer
          format: int32
          nullable: true
        year:
          type: integer
          format: int32
          nullable: true
        outputUsable:
          type: integer
          format: int64
          nullable: true
        biddingZone:
          type: string
          nullable: true
        interconnectorName:
          type: string
          nullable: true
        interconnector:
          type: boolean
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Dynamic.RateData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: RURE
        settlementDate:
          type: string
          format: date
          example: '2022-07-01'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        time:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        rate1:
          type: number
          format: double
          example: 0.4
        elbow2:
          type: number
          format: double
          nullable: true
          example: 5
        rate2:
          type: number
          format: double
          nullable: true
          example: 300.2
        elbow3:
          type: number
          format: double
          nullable: true
          example: null
        rate3:
          type: number
          format: double
          nullable: true
          example: null
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: YAFM
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-YAFM-00687705
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        businessType:
          type: string
          nullable: true
          example: Positive forecast margin
        year:
          type: integer
          format: int32
          example: 2023
        quantity:
          type: number
          format: double
          example: 1.08
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: NETBSAD
        settlementDate:
          type: string
          format: date
          example: '2022-06-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 29
        netBuyPriceCostAdjustmentEnergy:
          type: number
          format: double
          example: 0
        netBuyPriceVolumeAdjustmentEnergy:
          type: number
          format: double
          example: 0
        netBuyPriceVolumeAdjustmentSystem:
          type: number
          format: double
          example: 0
        buyPricePriceAdjustment:
          type: number
          format: double
          example: 0
        netSellPriceCostAdjustmentEnergy:
          type: number
          format: double
          example: 0
        netSellPriceVolumeAdjustmentEnergy:
          type: number
          format: double
          example: 0
        netSellPriceVolumeAdjustmentSystem:
          type: number
          format: double
          example: 0
        sellPricePriceAdjustment:
          type: number
          format: double
          example: 0
      additionalProperties: false
    Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        week:
          type: integer
          format: int32
        year:
          type: integer
          format: int32
        surplus:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PbcDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: PN
        settlementDate:
          type: string
          format: date
          example: '2022-07-01'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        timeFrom:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        timeTo:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        levelFrom:
          type: integer
          format: int32
          example: 5
        levelTo:
          type: integer
          format: int32
          example: 46
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.RateData'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: YATL
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-WATL-16209423
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        forecastYear:
          type: integer
          format: int32
          example: 2023
        forecastWeek:
          type: integer
          format: int32
          example: 30
        minimumPossible:
          type: number
          format: double
          example: 18034
        maximumAvailable:
          type: number
          format: double
          example: 35011
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: NONBM
        publishTime:
          type: string
          format: date-time
          example: '2022-06-25T13:34:00Z'
        startTime:
          type: string
          format: date-time
          example: '2022-06-25T13:00:00Z'
        settlementDate:
          type: string
          format: date
          example: '2022-06-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 29
        generation:
          type: integer
          format: int64
          example: 0
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: DISBSAD
        settlementDate:
          type: string
          format: date
          example: '2022-06-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 29
        id:
          type: integer
          format: int32
          example: 1
        cost:
          type: number
          format: double
          nullable: true
          example: 1850.9
        volume:
          type: number
          format: double
          example: 5
        soFlag:
          type: boolean
        storFlag:
          type: boolean
        partyId:
          type: string
          nullable: true
          example: ElectroRoute Energy Trading Limited
        assetId:
          type: string
          nullable: true
          example: ING-ELTR1
        isTendered:
          type: boolean
          nullable: true
        service:
          type: string
          nullable: true
          example: Energy
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SoSoPricesDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        margin:
          type: integer
          format: int64
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        boundary:
          type: string
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadTotalLoadPerBiddingZoneDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.MonthAheadTotalLoadPerBiddingZoneDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: MATL
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-WATL-16209423
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-05-25 23:00:10Z'
        forecastWeekCommencingDate:
          type: string
          format: date
          example: '2023-05-29'
        forecastYear:
          type: integer
          format: int32
          example: 2023
        forecastMonth:
          type: string
          nullable: true
          example: JUN
        minimumPossible:
          type: number
          format: double
          example: 18034
        maximumAvailable:
          type: number
          format: double
          example: 35011
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.RemitMessage:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: REMIT
        mrid:
          type: string
          nullable: true
          example: 11XINNOGY------2-NGET-RMT-00084421
        revisionNumber:
          type: integer
          format: int32
          example: 25
        publishTime:
          type: string
          format: date-time
          example: '2023-01-31T17:39:15Z'
        createdTime:
          type: string
          format: date-time
          example: '2023-01-31T17:39:15Z'
        messageType:
          type: string
          nullable: true
          example: UnavailabilitiesOfElectricityFacilities
        messageHeading:
          type: string
          nullable: true
          example: Planned Unavailability of Generation Unit
        eventType:
          type: string
          nullable: true
          example: Production unavailability
        unavailabilityType:
          type: string
          nullable: true
          example: Planned
        participantId:
          type: string
          nullable: true
          example: 11XINNOGY------2
        registrationCode:
          type: string
          nullable: true
          example: 11XINNOGY------2
        assetId:
          type: string
          nullable: true
          example: T_DIDCB5
        assetType:
          type: string
          nullable: true
          example: Production
        affectedUnit:
          type: string
          nullable: true
          example: DIDCB5
        affectedUnitEIC:
          type: string
          nullable: true
          example: 48W000000DIDCB5C
        affectedArea:
          type: string
          nullable: true
          example: N
        biddingZone:
          type: string
          nullable: true
          example: 10YGB----------A
        fuelType:
          type: string
          nullable: true
          example: Fossil Gas
        normalCapacity:
          type: number
          format: double
          nullable: true
          example: 780
        availableCapacity:
          type: number
          format: double
          nullable: true
          example: 320
        unavailableCapacity:
          type: number
          format: double
          nullable: true
          example: 361
        eventStatus:
          type: string
          nullable: true
          example: Inactive
        eventStartTime:
          type: string
          format: date-time
          example: '2022-08-23T06:59:00Z'
        eventEndTime:
          type: string
          format: date-time
          nullable: true
          example: '2022-08-25T05:20:30Z'
        durationUncertainty:
          type: string
          nullable: true
          example: +- 1 day
        cause:
          type: string
          nullable: true
          example: Other
        relatedInformation:
          type: string
          nullable: true
          example: Status changed to Completed
        outageProfile:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.OutageProfileData'
          nullable: true
          example:
          - startTime: '2023-02-03T21:06:31.000Z'
            endTime: '2023-02-03T21:10:00.000Z'
            capacity: 436
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.WindGenerationForecast:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        generation:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.DisaggregatedBalancingServicesAdjustmentData'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: AGPT
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-AGPT-06426954
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        businessType:
          type: string
          nullable: true
          example: Solar generation
        psrType:
          type: string
          nullable: true
          example: Solar
        quantity:
          type: number
          format: double
          example: 1829
        startTime:
          type: string
          format: date-time
          example: '2023-07-12 06:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-07-12'
        settlementPeriod:
          type: integer
          format: int32
          example: 16
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: SYSWARN
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: 2022-09-20T00:00Z
        warningType:
          type: string
          nullable: true
          example: SO-SO TRADES
        warningText:
          type: string
          nullable: true
          example: NATIONAL GRID NOTIFICATION of excess energy prices used for settlement outside of BALIT for SO to SO Transactions
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        forecastDate:
          type: string
          format: date
        demand:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferAcceptanceLevelDatasetResponse:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: BOALF
        settlementDate:
          type: string
          format: date
          example: '2022-07-25'
        settlementPeriodFrom:
          type: integer
          format: int32
          example: 29
        settlementPeriodTo:
          type: integer
          format: int32
          example: 32
        timeFrom:
          type: string
          format: date-time
          example: '2022-06-25T13:34:00Z'
        timeTo:
          type: string
          format: date-time
          example: '2022-06-25T13:37:00Z'
        levelFrom:
          type: integer
          format: int32
          example: 5
        levelTo:
          type: integer
          format: int32
          example: 46
        acceptanceNumber:
          type: integer
          format: int32
          example: 1234567
        acceptanceTime:
          type: string
          format: date-time
          example: '2022-06-25T13:37:00Z'
        deemedBoFlag:
          type: boolean
        soFlag:
          type: boolean
        amendmentFlag:
          type: string
          nullable: true
          example: ORI
        storFlag:
          type: boolean
        rrFlag:
          type: boolean
          nullable: true
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: MDV
        settlementDate:
          type: string
          format: date
          example: '2022-07-01'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        time:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        volumeMax:
          type: integer
          format: int64
          example: 31
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: FUELINST
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: '2022-06-25T13:00:00Z'
        startTime:
          type: string
          format: date-time
          nullable: true
          example: '2022-06-25T13:00:00Z'
        settlementDate:
          type: string
          format: date
          nullable: true
          example: '2022-06-25'
        settlementPeriod:
          type: integer
          format: int32
          nullable: true
          example: 3
        fuelType:
          type: string
          nullable: true
          example: BIOMASS
        generation:
          type: integer
          format: int64
          nullable: true
          example: 0
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusWeekly'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: INDOD
        publishTime:
          type: string
          format: date-time
          example: '2023-08-26T23:15:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-08-26'
        demand:
          type: integer
          format: int64
          nullable: true
          example: 494802
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedMargin'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DatasetRows.IndodDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.NoticeData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: NTB
        settlementDate:
          type: string
          format: date
          example: '2022-07-01'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        time:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        notice:
          type: integer
          format: int32
          example: 13
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.ActualTotalLoadPerBiddingZoneDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: ATL
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-ATL-06424732
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-06-29 17:25:09Z'
        startTime:
          type: string
          format: date-time
          example: '2023-06-29 15:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-06-29'
        settlementPeriod:
          type: integer
          format: int32
          example: 40
        quantity:
          type: number
          format: double
          example: 1000
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitDaily'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        generation:
          type: integer
          format: int64
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        boundary:
          type: string
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.AbucDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: ABUC
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-ABUC-00688983
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-08-22T07:43:04Z'
        businessType:
          type: string
          nullable: true
          example: Replacement reserve
        psrType:
          type: string
          nullable: true
          example: Generation
        marketAgreementType:
          type: string
          nullable: true
          example: Daily
        flowDirection:
          type: string
          nullable: true
          example: Up
        settlementDate:
          type: string
          format: date
          example: '2023-08-23'
        quantity:
          type: number
          format: double
          example: 1140
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        year:
          type: integer
          format: int32
        week:
          type: integer
          format: int32
        demand:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadTotalLoadPerBiddingZoneDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: DATL
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-DATL-16244005
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-08-05 12:00:08Z'
        startTime:
          type: string
          format: date-time
          example: '2023-08-06 23:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-08-07'
        settlementPeriod:
          type: integer
          format: int32
          example: 2
        quantity:
          type: number
          format: double
          example: 18648
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: MILS
        settlementDate:
          type: string
          format: date
          example: '2022-07-01'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        timeFrom:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        timeTo:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        levelFrom:
          type: integer
          format: int32
          example: 5
        levelTo:
          type: integer
          format: int32
          example: 46
        notificationTime:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        notificationSequence:
          type: integer
          format: int32
          example: 93210322
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemWarningsData'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.AobeDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: AOBE
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-AOBE-00879999
        timeSeriesId:
          type: string
          nullable: true
          example: NGET-EMFIP-AOBE-36758603
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-10-24T13:09:07Z'
        flowDirection:
          type: string
          nullable: true
          example: Up
        quantity:
          type: number
          format: double
          example: 12412
        secondaryQuantity:
          type: number
          format: double
          nullable: true
          example: 45.831
        startTime:
          type: string
          format: date-time
          example: '2023-09-11T14:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-09-11'
        settlementPeriod:
          type: integer
          format: int32
          example: 32
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
          nullable: true
        systemZone:
          type: string
          nullable: true
        calendarWeekNumber:
          type: integer
          format: int32
          nullable: true
        year:
          type: integer
          format: int32
          nullable: true
        outputUsable:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: TUDM
        serialNumber:
          type: string
          nullable: true
          example: 000000980321
        fileCreationTime:
          type: string
          format: date-time
          example: '2023-10-19T07:01:07.000'
        tradingUnitType:
          type: string
          nullable: true
          example: Base
        tradingUnitName:
          type: string
          nullable: true
          example: DEFAULT__A
        settlementDate:
          type: string
          format: date
          example: '2022-07-30'
        settlementPeriod:
          type: integer
          format: int32
          example: 5
        settlementRunType:
          type: string
          nullable: true
          example: RF
        startTime:
          type: string
          format: date-time
          example: '2022-07-30T10:30:00Z'
        deliveryMode:
          type: string
          nullable: true
          example: Offtaking
        importVolume:
          type: number
          format: double
          example: 209.95
        exportVolume:
          type: number
          format: double
          example: -1372.384
        netVolume:
          type: number
          format: double
          example: -1162.434
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: WATL
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-WATL-16209423
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        forecastDate:
          type: string
          format: date
          example: '2023-07-24'
        forecastWeek:
          type: integer
          format: int32
          example: 30
        minimumPossible:
          type: number
          format: double
          example: 18034
        maximumAvailable:
          type: number
          format: double
          example: 35011
      additionalProperties: false
    Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedDemand:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        demand:
          type: integer
          format: int64
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        boundary:
          type: string
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.CostsOfCongestionManagementDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: CCM
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-CCM-00688999
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        businessType:
          type: string
          nullable: true
          example: Congestion costs
        year:
          type: integer
          format: int32
          example: 2023
        month:
          type: string
          nullable: true
          example: OCT
        amount:
          type: number
          format: double
          example: 1.08
      additionalProperties: false
    Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnTransmission:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        demand:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: FEIB
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-FEIB-00687316
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2021-09-21T10:04:24Z'
        status:
          type: string
          nullable: true
          example: Intermediate
        year:
          type: integer
          format: int32
          example: 2021
        month:
          type: string
          nullable: true
          example: JUL
        amount:
          type: number
          format: double
          example: 77112420
        priceDirection:
          type: string
          nullable: true
          example: Expenditure
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.NonBmStorData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.StablePortageLimitData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: SEL
        settlementDate:
          type: string
          format: date
          example: '2022-07-01'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        time:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        level:
          type: integer
          format: int32
          example: 5
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityWeekly'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandForecastDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: RZDF
        submissionDateTime:
          type: string
          format: date-time
          example: '2025-01-01T07:01:07'
        publishTime:
          type: string
          format: date-time
          example: '2025-01-01T00:00:10'
        settlementDate:
          type: string
          format: date
          example: '2025-01-02'
        region:
          type: string
          nullable: true
          example: North Scotland
        gspGroupId:
          type: string
          nullable: true
          example: _A
        forecastDemand60:
          type: integer
          format: int32
          example: 1234
        forecastDemand100:
          type: integer
          format: int32
          example: 12345
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        week:
          type: integer
          format: int32
        year:
          type: integer
          format: int32
        margin:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.SystemFrequency:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        measurementTime:
          type: string
          format: date-time
        frequency:
          type: number
          format: double
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.BalancingServicesVolumeData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        fuelType:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
          nullable: true
        systemZone:
          type: string
          nullable: true
        forecastDate:
          type: string
          format: date
        forecastDateTimezone:
          type: string
          nullable: true
          readOnly: true
        outputUsable:
          type: integer
          format: int64
          nullable: true
        biddingZone:
          type: string
          nullable: true
        interconnectorName:
          type: string
          nullable: true
        interconnector:
          type: boolean
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByFuelTypeWeekly'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.DatasetRows.NetBalancingServicesAdjustmentData'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDayAhead:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        demand:
          type: integer
          format: int64
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        boundary:
          type: string
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMinData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: MZT
        settlementDate:
          type: string
          format: date
          example: '2022-07-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        time:
          type: string
          format: date-time
          example: '2022-07-25T09:34:00Z'
        periodMin:
          type: integer
          format: int32
          example: 360
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.ForecastSurplus.DatasetRows.ForecastSurplusDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        forecastDate:
          type: string
          format: date
        surplus:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
          nullable: true
        systemZone:
          type: string
          nullable: true
        forecastDate:
          type: string
          format: date
        forecastDateTimezone:
          type: string
          nullable: true
          readOnly: true
        outputUsable:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryPeriodMaxData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: MDP
        settlementDate:
          type: string
          format: date
          example: '2022-07-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        time:
          type: string
          format: date-time
          example: '2022-07-25T09:34:00Z'
        periodMax:
          type: integer
          format: int32
          example: 360
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedGeneration'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.CreditDefaultNoticeDatasetResponse:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: CDN
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: 2022-09-20T00:00Z
        bscPartyId:
          type: string
          nullable: true
          example: INVE
        creditDefaultLevel:
          type: integer
          format: int32
          example: 1
        enteredDefaultSettlementDate:
          type: string
          format: date
          example: '2022-06-25'
        enteredDefaultSettlementPeriod:
          type: integer
          format: int32
          example: 3
        clearedDefaultSettlementDate:
          type: string
          format: date
          nullable: true
          example: '2022-07-02'
        clearedDefaultSettlementPeriod:
          type: integer
          format: int32
          nullable: true
          example: 29
        clearedDefaultText:
          type: string
          nullable: true
          example: Credit Cover Percentage greater than or equal to 90% of Credit Limit (Level 2 Default)
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.LossOfLoadProbabilityDeratedMarginData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: LOLPDRM
        publishTime:
          type: string
          format: date-time
          example: '2023-01-31 17:39:15Z'
        publishingPeriodCommencingTime:
          type: string
          format: date-time
          example: 2023-01-31 17:30Z
        startTime:
          type: string
          format: date-time
          example: 2023-01-31 18:30Z
        settlementDate:
          type: string
          format: date
          example: '2023-01-31'
        settlementPeriod:
          type: integer
          format: int32
          example: 38
        lossOfLoadProbability:
          type: number
          format: double
          nullable: true
          example: 0
        deratedMargin:
          type: number
          format: double
          nullable: true
          example: 12570.207
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationOutputPerGenerationUnitDatasetResponse:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: B1610
        psrType:
          type: string
          nullable: true
          example: Generation
        bmUnit:
          type: string
          nullable: true
          example: T_CNQPS-1
        nationalGridBmUnitId:
          type: string
          nullable: true
          example: CNQPS-1
        settlementDate:
          type: string
          format: date
          example: '2022-08-12'
        settlementPeriod:
          type: integer
          format: int32
          example: 10
        halfHourEndTime:
          type: string
          format: date-time
          example: '2022-08-12T04:00:00Z'
        quantity:
          type: number
          format: double
          example: 116.109
      additionalProperties: false
    Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        year:
          type: integer
          format: int32
        week:
          type: integer
          format: int32
        demand:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualAggregatedGenerationPerTypeDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        forecastDate:
          type: string
          format: date
        demand:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.YearAheadForecastMarginDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.TudmDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.MarketIndexDatasetResponse:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: MID
        startTime:
          type: string
          format: date-time
          example: '2022-09-26T13:00:00Z'
        dataProvider:
          type: string
          nullable: true
          example: N2EXMIDP
        settlementDate:
          type: string
          format: date
          example: '2022-09-26'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        price:
          type: number
          format: double
          example: 678.12
        volume:
          type: number
          format: double
          example: 678.123
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.IgcaDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: IGCA
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-IGCA-00687002
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2022-04-21T13:25:52Z'
        businessType:
          type: string
          nullable: true
          example: Installed generation
        psrType:
          type: string
          nullable: true
          example: Hydro Pumped Storage
        year:
          type: integer
          format: int32
          example: 2022
        quantity:
          type: number
          format: double
          example: 1928
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.FeibDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.DeliveryLimitMaxData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        lastUpdated:
          type: string
          format: date-time
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.IndicatedForecast.DatasetRows.IndicatedImbalance:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        imbalance:
          type: integer
          format: int64
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        boundary:
          type: string
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.DatasetRows.PhysicalNotificationData'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.WeekAheadTotalLoadPerBiddingZoneDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: RZDR
        submissionDateTime:
          type: string
          format: date-time
          example: '2025-01-01T07:01:07'
        publishTime:
          type: string
          format: date-time
          example: '2025-01-01T00:00:10'
        region:
          type: string
          nullable: true
          example: North Scotland
        gspGroupId:
          type: string
          nullable: true
          example: _A
        restoredDemand:
          type: integer
          format: int32
          example: 1234
      additionalProperties: false
    Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDayAhead:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        demand:
          type: integer
          format: int64
          nullable: true
        publishTime:
          type: string
          format: date-time
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        boundary:
          type: string
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityByBmUnitWeekly:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        fuelType:
          type: string
          nullable: true
          example: CCGT
        nationalGridBmUnit:
          type: string
          nullable: true
          example: CARR-1
        bmUnit:
          type: string
          nullable: true
          example: T_CARR-1
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: '2022-08-10T15:00:00Z'
        week:
          type: integer
          format: int32
          nullable: true
          example: 34
        year:
          type: integer
          format: int32
          nullable: true
          example: 2022
        outputUsable:
          type: integer
          format: int64
          nullable: true
          example: 442
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastNationalDaily'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.ActualGenerationWindSolarDatasetRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.DeliveryVolumeMaxData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.Remit.DatasetRows.OutageProfileData:
      type: object
      properties:
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        capacity:
          type: number
          format: double
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.BebDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: BEB
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-BEB-00688983
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-08-22T07:43:04Z'
        bidId:
          type: string
          nullable: true
          example: NGET-EMFIP-BEB-TS-36758603
        flowDirection:
          type: string
          nullable: true
          example: Up
        quantity:
          type: number
          format: double
          example: 1140
        energyPrice:
          type: number
          format: double
          example: 150
        startTime:
          type: string
          format: date-time
          example: '2023-08-22T07:43:04Z'
        settlementDate:
          type: string
          format: date
          example: '2023-08-23'
        settlementPeriod:
          type: integer
          format: int32
          example: 1
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AugmentedOutturnData'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Balancing.DatasetRows.BidOfferDatasetResponse:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: BOD
        settlementDate:
          type: string
          format: date
          example: '2022-07-25'
        settlementPeriod:
          type: integer
          format: int32
          example: 3
        timeFrom:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        levelFrom:
          type: integer
          format: int32
          example: 5
        timeTo:
          type: string
          format: date-time
          example: '2022-07-01T13:34:00Z'
        levelTo:
          type: integer
          format: int32
          example: 46
        pairId:
          type: integer
          format: int32
          example: 1
        offer:
          type: number
          format: double
          example: -71.5
        bid:
          type: number
          format: double
          example: 668.67
        nationalGridBmUnit:
          type: string
          nullable: true
          example: ABRBO-1
        bmUnit:
          type: string
          nullable: true
          example: T_ABRBO-1
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.PpbrDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: PPBR
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-PPBR-00688983
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-08-22T07:43:04Z'
        psrType:
          type: string
          nullable: true
          example: Generation
        marketAgreementType:
          type: string
          nullable: true
          example: Daily
        flowDirection:
          type: string
          nullable: true
          example: Up
        settlementDate:
          type: string
          format: date
          example: '2023-08-23'
        amount:
          type: number
          format: double
          example: 1.2
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: DGWS
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-DGWSINTRADAY-06043339
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        processType:
          type: string
          nullable: true
          example: Intraday process
        businessType:
          type: string
          nullable: true
          example: Wind generation
        psrType:
          type: string
          nullable: true
          example: Wind Offshore
        quantity:
          type: number
          format: double
          example: 1829
        startTime:
          type: string
          format: date-time
          example: '2023-07-12 06:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-07-12'
        settlementPeriod:
          type: integer
          format: int32
          example: 16
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.TemperatureData:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        measurementDate:
          type: string
          format: date
        publishTime:
          type: string
          format: date-time
        temperature:
          type: number
          format: double
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadAggregatedGenerationDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: DAG
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-DAG-06244336
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-07-12 05:00:00Z'
        quantity:
          type: number
          format: double
          example: 1804.5
        startTime:
          type: string
          format: date-time
          example: '2023-07-12 06:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-07-12'
        settlementPeriod:
          type: integer
          format: int32
          example: 16
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.IgcpuDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: IGCPU
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-CONF-00688811
        publishTime:
          type: string
          format: date-time
          example: '2022-04-21T13:25:52Z'
        effectiveFrom:
          type: string
          format: date
          example: '2023-08-07'
        psrType:
          type: string
          nullable: true
          example: Other
        registeredResourceEicCode:
          type: string
          nullable: true
          example: 48WVPI-TRAD-BMUI
        registeredResourceName:
          type: string
          nullable: true
          example: DBAWO-1
        bmUnit:
          type: string
          nullable: true
          example: T_DBAWO-1
        voltageLimit:
          type: number
          format: double
          nullable: true
          example: 2234.1
        installedCapacity:
          type: number
          format: double
          example: 1928.2
      additionalProperties: false
    Insights.Api.Models.Responses.DemandOutturn.DatasetRows.DemandOutturnNational:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
          nullable: true
        startTime:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date
        settlementPeriod:
          type: integer
          format: int32
        demand:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Transparency.DatasetRows.CbsDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: CBS
        documentId:
          type: string
          nullable: true
          example: NGET-EMFIP-CBS-00879999
        documentRevisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          example: '2023-10-24T13:09:07Z'
        flowDirection:
          type: string
          nullable: true
          example: Up
        quantity:
          type: number
          format: double
          example: 12412
        timeFrom:
          type: string
          format: date-time
          example: '2023-09-11T14:30:00Z'
        timeTo:
          type: string
          format: date-time
          example: '2023-09-11T14:30:00Z'
        settlementDate:
          type: string
          format: date
          example: '2023-09-11'
        settlementPeriod:
          type: integer
          format: int32
          example: 32
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DatasetRows.DemandForecastTransmissionDaily'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Reference.DatasetMetadataLatestRow'
          nullable: true
      additionalProperties: false
    ? Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow
    : type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Transparency.DatasetRows.DayAheadGenerationForWindAndSolarDatasetRow'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.Misc.DatasetRows.DemandControlInstructionDatasetRow:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
          example: DCI
        mRID:
          type: string
          nullable: true
          example: DCI_202104300853_00000030
        revisionNumber:
          type: integer
          format: int32
          example: 1
        publishTime:
          type: string
          format: date-time
          nullable: true
          example: '2021-04-30T08:53:39Z'
        publishingPeriodCommencingTime:
          type: string
          format: date-time
          example: '2021-04-30T08:53:39Z'
        affectedDso:
          type: string
          nullable: true
          example: SP(D)
        demandControlId:
          type: string
          nullable: true
          example: '00135'
        instructionSequence:
          type: integer
          format: int32
          example: 1
        demandControlEventFlag:
          type: string
          example: I
        timeFrom:
          type: string
          format: date-time
          example: '2021-04-30T12:45:00Z'
        timeTo:
          type: string
          format: date-time
          nullable: true
          example: '2021-04-30T13:09:00Z'
        volume:
          type: number
          format: double
          example: 68
        systemManagementActionFlag:
          type: string
          nullable: true
          example: T
        amendmentFlag:
          type: string
          nullable: true
          example: ORI
      additionalProperties: false
    Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Insights.Api.Models.Responses.Generation.DatasetRows.AvailabilityDaily'
          nullable: true
      additionalProperties: false
    Insights.Api.Models.Responses.ForecastMargin.DatasetRows.ForecastMarginDaily:
      type: object
      properties:
        dataset:
          type: string
          nullable: true
        publishTime:
          type: string
          format: date-time
        forecastDate:
          type: string
          format: date
        margin:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false