{
"openapi": "3.0.4",
"info": {
"title": "Insights.Api",
"version": "1.0"
},
"servers": [
{
"url": "https://data.elexon.co.uk/bmrs/api/v1"
}
],
"paths": {
"/balancing/dynamic": {
"get": {
"tags": [
"Balancing Mechanism Dynamic"
],
"summary": "Dynamic data per BMU (SEL, SIL, MZT, MNZT, MDV, MDP, NTB, NTO, NDZ)",
"description": "This endpoint provides the dynamic data for a requested BMU, excluding physical rate data.\nIt returns a \"snapshot\" of data valid at a given time, and optionally a time series of changes over a requested interval.\n \nBy default, all of the relevant datasets are returned: SIL, SEL, NDZ, NTB, NTO, MZT, MNZT, MDV, MDP.\nThe results from each dataset are transformed to a common response model, with the common integer field *Value*\nmapped from the fields *Level*, *Period*, *Volume* or *Notice* in the original dataset, as relevant.",
"parameters": [
{
"name": "bmUnit",
"in": "query",
"description": "The BM Unit to query.",
"required": true,
"schema": {
"type": "string",
"example": "2__HFLEX001"
},
"example": "2__HFLEX001"
},
{
"name": "snapshotAt",
"in": "query",
"description": "When to retrieve a snapshot of data at.\nThat is, the latest datapoint before this time will be returned for each dataset.",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-08-23T00:00Z"
},
"example": "2022-08-23T00:00Z"
},
{
"name": "until",
"in": "query",
"description": "When to retrieve data until.\nData from the snapshot until this time will be returned.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-08-24T00:00Z"
},
"example": "2022-08-24T00:00Z"
},
{
"name": "snapshotAtSettlementPeriod",
"in": "query",
"description": "The settlement period to retrieve a snapshot of data at.\nIf provided, the time part of SnapshotAt will be ignored.",
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
},
{
"name": "untilSettlementPeriod",
"in": "query",
"description": "The settlement period to retrieve data until.\nIf provided, the time part of Until will be ignored.",
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
},
{
"name": "dataset",
"in": "query",
"description": "Datasets to filter. If omitted, all datasets will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SEL",
"MNZT",
"MDP"
]
},
"example": [
"SEL",
"MNZT",
"MDP"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/dynamic/all": {
"get": {
"tags": [
"Balancing Mechanism Dynamic"
],
"summary": "Market-wide dynamic data (SEL, SIL, MZT, MNZT, MDV, MDP, NTB, NTO, NDZ)",
"description": "This endpoint provides the dynamic data for multiple requested BMUs or all BMUs, excluding dynamic rate data.\nIt returns the data valid for a single settlement period. This includes a snapshot of data valid at the start\nof the settlement period, and any changes published during that settlement period.\n \nBy default, all of the relevant datasets are returned: SIL, SEL, NDZ, NTB, NTO, MZT, MNZT, MDV & MDP.\nThe results from each dataset are transformed to a common response model, with the common integer field *Value*\nmapped from the fields *Level*, *Period*, *Volume* or *Notice* in the original dataset, as relevant.\n \nThe settlement period must be specified as a date and settlement period. The date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date or datetime to filter.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-18"
},
"example": "2023-01-18"
},
{
"name": "settlementPeriod",
"in": "query",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 3
},
"example": 3
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2__HFLEX001",
"HUMR-1"
]
},
"example": [
"2__HFLEX001",
"HUMR-1"
]
},
{
"name": "dataset",
"in": "query",
"description": "Datasets to filter. If omitted, all datasets will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SEL",
"MNZT",
"MDP"
]
},
"example": [
"SEL",
"MNZT",
"MDP"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/dynamic/rates": {
"get": {
"tags": [
"Balancing Mechanism Dynamic"
],
"summary": "Rate data per BMU (RDRE, RURE, RDRI, RURI)",
"description": "This endpoint provides the physical rate data for a requested BMU.\nIt returns a \"snapshot\" of data valid at a given time, and optionally a time series of changes over a requested interval.\n \nBy default, all of the relevant datasets are returned: RDRE, RURE, RDRI, RURI.",
"parameters": [
{
"name": "bmUnit",
"in": "query",
"description": "The BM Unit to query.",
"required": true,
"schema": {
"type": "string",
"example": "DRAXX-1"
},
"example": "DRAXX-1"
},
{
"name": "snapshotAt",
"in": "query",
"description": "When to retrieve a snapshot of data at.\nThat is, the latest datapoint before this time will be returned for each dataset.",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-09-01T00:00Z"
},
"example": "2022-09-01T00:00Z"
},
{
"name": "until",
"in": "query",
"description": "When to retrieve data until.\nData from the snapshot until this time will be returned.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2022-09-30T00:00Z"
},
"example": "2022-09-30T00:00Z"
},
{
"name": "snapshotAtSettlementPeriod",
"in": "query",
"description": "The settlement period to retrieve a snapshot of data at.\nIf provided, the time part of SnapshotAt will be ignored.",
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
},
{
"name": "untilSettlementPeriod",
"in": "query",
"description": "The settlement period to retrieve data until.\nIf provided, the time part of Until will be ignored.",
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
},
{
"name": "dataset",
"in": "query",
"description": "Datasets to filter. If empty, all datasets will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"RURE",
"RDRE",
"RDRI"
]
},
"example": [
"RURE",
"RDRE",
"RDRI"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-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"
}
}
}
},
"/balancing/dynamic/rates/all": {
"get": {
"tags": [
"Balancing Mechanism Dynamic"
],
"summary": "Market-wide rate data (RDRE, RURE, RDRI, RURI)",
"description": "This endpoint provides market-wide physical rate data, for all BMUs or a requested set of multiple BMUs.\nIt returns the data valid for a given settlement period. This includes a snapshot of data valid at the start\nof the settlement period, and any changes published during that settlement period.\n \nThe settlement period to query can be specified as a date and settlement period. The settlement date must be provided in the format yyyy-MM-dd.\n\nBy default, all of the relevant datasets are returned: RDRE, RURE, RDRI, RURI.\n \nThis endpoint is quota limited.\nFor individual rate datasets, use the relevant /datasets/ endpoints.\nFor real-time updates as each data point is published, use the Insights IRIS service. You can register for free at https://bmrs.elexon.co.uk/iris .\nFor historical data, check out the IRIS archive, which keeps a record of all published datasets.",
"parameters": [
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date to filter.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-01"
},
"example": "2022-09-01"
},
{
"name": "settlementPeriod",
"in": "query",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2__HFLEX001",
"HUMR-1"
]
},
"example": [
"2__HFLEX001",
"HUMR-1"
]
},
{
"name": "dataset",
"in": "query",
"description": "Datasets to return. If omitted, all datasets will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"RURE",
"RDRE",
"RDRI"
]
},
"example": [
"RURE",
"RDRE",
"RDRI"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.RateData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-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"
}
}
}
},
"/balancing/physical": {
"get": {
"tags": [
"Balancing Mechanism Physical"
],
"summary": "Physical data per BMU (PN, QPN, MILS, MELS)",
"description": "This endpoint provides the physical data for a requested BMU.\nIt returns the data valid over a given time range.\n \nBy default, all of the relevant datasets are returned: PN, QPN, MILS, & MELS.\nThe results from each dataset are transformed to a common response model, with fields not present in all 4 datasets dropped.\n \nBy default, the from and to parameters filter the data by start 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 start 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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/physical?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/physical?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to start time:\n \n /balancing/physical?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 /balancing/physical?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1",
"parameters": [
{
"name": "bmUnit",
"in": "query",
"description": "The BM Unit to query.",
"required": true,
"schema": {
"type": "string",
"example": "2__HFLEX001"
},
"example": "2__HFLEX001"
},
{
"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-23T00:00Z"
},
"example": "2022-09-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": "dataset",
"in": "query",
"description": "Datasets to filter. If empty, all datasets will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"PN",
"MILS"
]
},
"example": [
"PN",
"MILS"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/physical/all": {
"get": {
"tags": [
"Balancing Mechanism Physical"
],
"summary": "Market-wide physical data (PN, QPN, MILS, MELS)",
"description": "This endpoint provides the physical data for multiple requested BMUs or all BMUs.\nIt returns the data valid for a single settlement period.\n \nOnly one dataset can be queried at a time: PN, QPN, MILS, or MELS.\nThe results from each dataset are transformed to a common response model, with fields not present in all 4 datasets dropped.\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.",
"parameters": [
{
"name": "dataset",
"in": "query",
"description": "Dataset to query.",
"required": true,
"schema": {
"enum": [
"PN",
"QPN",
"MILS",
"MELS"
],
"type": "string",
"example": "PN"
},
"example": "PN"
},
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date for the filter.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-18"
},
"example": "2023-01-18"
},
{
"name": "settlementPeriod",
"in": "query",
"description": "The settlement period for the filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 3
},
"example": 3
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2__HFLEX001",
"HUMR-1"
]
},
"example": [
"2__HFLEX001",
"HUMR-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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/disbsad/summary": {
"get": {
"tags": [
"Balancing Services Adjustment - Disaggregated"
],
"summary": "Disaggregated balancing services adjustment time series (DISBSAD)",
"description": "This endpoint provides disaggregated balancing services adjustment data batched by settlement period. Each\nbatch in the time series contains a summary of all records for that settlement period, detailing the number of\nbuy and sell actions, price information and volume information.\n\nBy default, the from and to parameters filter the data by start 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 start 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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/nonbm/disbsad/summary?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/nonbm/disbsad/summary?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to start time:\n \n /balancing/nonbm/disbsad/summary?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 /balancing/nonbm/disbsad/summary?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-20T00:00Z"
},
"example": "2022-09-20T00: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-27T00:00Z"
},
"example": "2022-09-27T00: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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/disbsad/details": {
"get": {
"tags": [
"Balancing Services Adjustment - Disaggregated"
],
"summary": "Disaggregated balancing services adjustment per settlement period (DISBSAD)",
"description": "This endpoint provides disaggregated balancing services adjustment data for a single settlement period. The\nresponse includes all the buying and selling actions that occurred during that settlement period.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date to query.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-10-26"
},
"example": "2022-10-26"
},
{
"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": 3
},
"example": 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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/netbsad": {
"get": {
"tags": [
"Balancing Services Adjustment - Net"
],
"summary": "Net balancing services adjustment time series (NETBSAD)",
"description": "This endpoint provides data about the Net Balancing Services Adjustment (NETBSAD). Each\nentry in the time series contains the NETBSAD values for that settlement 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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/nonbm/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/nonbm/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 /balancing/nonbm/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 /balancing/nonbm/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-06-01T00:00Z",
"x-max-day-range-including-zeroes": 31,
"x-max-day-range-excluding-zeroes": 3653
},
"example": "2022-06-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-07-01T00:00Z"
},
"example": "2022-07-01T00: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": "includeZero",
"in": "query",
"description": "Include data points with a generation of zero.",
"schema": {
"type": "boolean",
"example": false
},
"example": false
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/netbsad/events": {
"get": {
"tags": [
"Balancing Services Adjustment - Net"
],
"summary": "Net balancing services adjustment events (NETBSAD)",
"description": "This endpoint provides data about the start of NGESO Net Balancing Services Adjustment (NETBSAD) events.\nAn event is a point in time where one of the NETBSAD values has changed from 0 to a value.\nEach event details the start time of the event and the NETBSAD values associated with the start of the event.\n \nBy default, the before parameter filters the data by start time. If the settlementPeriodBefore parameter is\nprovided, the before parameter instead filters on settlement date, allowing for searching by start time or\nsettlement date & settlement period.\nNote: When filtering via settlement date, before is treated as a Date 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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering latest 3 events:\n \n /balancing/nonbm/netbsad/events?count=3\n \nFiltering latest 3 events before start time:\n \n /balancing/nonbm/netbsad/events?before=2022-08-01T00:00Z&count=3\n \nFiltering latest 3 events before settlement date and settlement period:\n \n /balancing/nonbm/netbsad/events?before=2022-08-01T00:00Z&settlementPeriodBefore=48&count=3",
"parameters": [
{
"name": "count",
"in": "query",
"description": "The number of events to return.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 3,
"x-max-event-count": 100
},
"example": 3
},
{
"name": "before",
"in": "query",
"description": "If specified, filters events to those with a start time before or at the date, or a settlement date before the date if\nsettlementPeriodBefore is also specified.\nIf omitted, latest events are returned.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "settlementPeriodBefore",
"in": "query",
"description": "Filters events to those with a settlement period before or at the value.\nBefore parameter must be specified if this is specified.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/bid-offer": {
"get": {
"tags": [
"Bid-Offer"
],
"summary": "Bid-offer data per BMU (BOD)",
"description": "This endpoint provides the bid-offer data for a requested BMU. It returns the data valid over a given time\nrange, excluding any results where LevelFrom and LevelTo are both zero.\n \nBy default, the from and to parameters filter the data inclusively and this endpoint will return any data that\noverlaps even at a single instant. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it\nwill instead filter to return any data that overlaps with the specified range of settlement periods. It is\npossible to search using a combination of time and/or settlement date & settlement period. Note: When\nfiltering via settlement date, from/to are treated as Dates only, with the time being ignored. For example,\n2022-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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering by timeFrom and timeTo:\n \n /balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from timeFrom to settlement date and period:\n \n /balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to TimeTo:\n \n /balancing/bid-offer?bmUnit=T_DRAXX-1&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 /balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1",
"parameters": [
{
"name": "bmUnit",
"in": "query",
"description": "The BM Unit to query.",
"required": true,
"schema": {
"type": "string",
"example": "2__HFLEX001"
},
"example": "2__HFLEX001"
},
{
"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-23T00:00Z"
},
"example": "2022-09-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": "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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/bid-offer/all": {
"get": {
"tags": [
"Bid-Offer"
],
"summary": "Market-wide bid-offer data (BOD)",
"description": "This endpoint provides market-wide bid-offer data, for all BMUs or a requested set of multiple BMUs.\nIt returns the data valid for a given settlement period, excluding any results where LevelFrom and LevelTo are both zero.\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 filter.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-22"
},
"example": "2022-09-22"
},
{
"name": "settlementPeriod",
"in": "query",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 1
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2__HFLEX001",
"HUMR-1"
]
},
"example": [
"2__HFLEX001",
"HUMR-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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/acceptances": {
"get": {
"tags": [
"Bid-Offer Acceptances"
],
"summary": "Bid-offer acceptances per BMU (BOALF)",
"description": "This endpoint provides the bid-offer acceptance data (BOALF) for a requested BMU.\n \nBy default, the from and to parameters filter the data by start 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 start 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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to start time:\n \n /balancing/acceptances?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 /balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1",
"parameters": [
{
"name": "bmUnit",
"in": "query",
"description": "The BM Unit to query.",
"required": true,
"schema": {
"type": "string",
"example": "T_MILWW-1"
},
"example": "T_MILWW-1"
},
{
"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-03T00:00Z"
},
"example": "2022-10-03T00: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-06T00:00Z"
},
"example": "2022-10-06T00: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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/acceptances/all": {
"get": {
"tags": [
"Bid-Offer Acceptances"
],
"summary": "Market-wide bid-offer acceptances (BOALF)",
"description": "This endpoint provides the bid-offer acceptance data (BOALF) for multiple requested BMUs or all BMUs.\nIt returns the data valid for a single settlement period.\n \nThe settlement period must be specified as a date and settlement period. The date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date for the filter.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-24"
},
"example": "2023-01-24"
},
{
"name": "settlementPeriod",
"in": "query",
"description": "The settlement period for the filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 39
},
"example": 39
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"T_DINO-2",
"HUMR-1"
]
},
"example": [
"T_DINO-2",
"HUMR-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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/acceptances/all/latest": {
"get": {
"tags": [
"Bid-Offer Acceptances"
],
"summary": "Latest market-wide bid-offer acceptances (BOALF)",
"description": "This endpoint provides the latest market-wide bid-offer acceptance data (BOALF). The latest 100 acceptances will be returned.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/acceptances/{acceptanceNumber}": {
"get": {
"tags": [
"Bid-Offer Acceptances"
],
"summary": "Bid-Offer acceptances by acceptance id",
"description": "This endpoint returns bid-offer acceptances for a given acceptance id.\nAcceptance ids must be integers.",
"parameters": [
{
"name": "acceptanceNumber",
"in": "path",
"description": "The acceptance id to filter results by.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 4162
},
"example": 4162
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
}
}
}
},
"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": {
"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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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.\nIf 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\nrepresentative of the temperature for Great Britain. Data is gathered from 6 weather stations.\nDefault 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\nmidday. Expressed as an average MW value for each Settlement period. The indicated generation\nforecast for each period is the sum of all the PNs submitted for BM Units which are forecast to\nbe exporting energy, presented as a single average MW value 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.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\nmidday. Expressed as an average MW value for each settlement period. The indicated generation\nforecast for each period is the sum of all the PNs submitted for BM Units which are forecast to\nbe exporting energy, presented as a single average MW value for the settlement period.\n\nThis 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\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 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.\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 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.\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 National Demand forecast made by the System Operator.\n\nThis 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 .\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 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.\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.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.\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.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\ndemand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding\nstation transformer, pumping and interconnector export demand. It is calculated from summing the half hourly\nINDO demands (divided by two to convert to MWh).\n\nThis 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\ndemand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding\nstation transformer, pumping and interconnector export demand. It is calculated from summing the half hourly\nINDO demands (divided by two to convert to MWh).\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-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.\nData 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 forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.\n\nThis API endpoint provides a maximum data output range of 92 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.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.\nData 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 forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES transmission losses, but EXCLUDES Interconnector flows and demand from station\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.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.\nData is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.\nExpressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.\n\nThis API endpoint provides a maximum data output range of 366 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.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.\nData is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.\nExpressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.\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.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.\nData is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.\nExpressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.\n\nThis API will provide a maximum data output range of 366 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.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.\nData is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead.\nExpressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain.\nThis value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station.\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.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.\nThe default output will be the latest published data.\n\nThis 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.\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\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.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.\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\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.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.\nIt shows the weekly peak half hour MW value of generating plant demand surplus for each day for the 2-156 weeks ahead.\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.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.\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\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.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\npublishTime 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\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": "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.\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": "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.\nThis 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.\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-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.\n\nThis 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).\nThis 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).\nThis 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).\nThis 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).\nThis 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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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\nRFC 3339.\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.\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\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/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.\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/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.\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": "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.\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-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.\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/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.\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.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\nand maximum available loads provided in MW values.\n\nThis 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\nand maximum available loads provided in MW values.\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: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\nand maximum available loads provided in MW values.\n\nThis 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\nand maximum available loads provided in MW values.\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: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\nand maximum available loads provided in MW values.\n\nThis 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\nand maximum available loads provided in MW values.\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: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.\n\nThis 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.\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: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.\n\nThis 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.\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-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.\n\nThis 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.\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-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.\n\nThis 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.\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-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.\n\nThis 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.\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-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.\n\nThis 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.\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-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.\n\nThis 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.\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-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.\n\nThis 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.\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": "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"
}
}
}
},
"/CDN": {
"get": {
"tags": [
"Credit Default Notice"
],
"summary": "[DEPRECATED] Credit default notices (CDN)",
"description": "This endpoint has been moved to balancing/settlement/default-notices.",
"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": "OK"
}
},
"deprecated": true
}
},
"/data-status/ISPSTACK": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested ISPSTACK Data",
"description": "This endpoint provides information about the number of data points ingested for the ISPSTACK dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/FREQ": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested FREQ Data",
"description": "This endpoint provides information about the number of data points ingested for the FREQ dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/BOALF": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested BOALF Data",
"description": "This endpoint provides information about the number of data points ingested for the BOALF dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/DISEBSP": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested DISEBSP Data",
"description": "This endpoint provides information about the number of data points ingested for the DISEBSP dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/DISPTAV": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested DISPTAV Data",
"description": "This endpoint provides information about the number of data points ingested for the DISPTAV dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/DISBSAD": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested DISBSAD Data",
"description": "This endpoint provides information about the number of data points ingested for the DISBSAD dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/NETBSAD": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested NETBSAD Data",
"description": "This endpoint provides information about the number of data points ingested for the NETBSAD dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/BOD": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested BOD Data",
"description": "This endpoint provides information about the number of data points ingested for the BOD dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/EBOCF": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested EBOCF Data",
"description": "This endpoint provides information about the number of data points ingested for the EBOCF dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/BOAV": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested BOAV Data",
"description": "This endpoint provides information about the number of data points ingested for the BOAV dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/PN": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested PN Data",
"description": "This endpoint provides information about the number of data points ingested for the PN dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/data-status/REMIT": {
"get": {
"tags": [
"Data Status"
],
"summary": "Status of ingested REMIT Data",
"description": "This endpoint provides information about the number of data points ingested for the REMIT dataset.\n \nThe settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint\nwill return data for up to the last 25 Settlement Periods, including the current one.\n \nThe source parameter is optional and allows filtering by data source:\n- 'Elexon' for Elexon Portal data (files prefixed with ELXP-RMT)\n- 'MFT' for MFT data (files prefixed with NGET-RMT)\n- If not provided, returns total data points from all sources",
"parameters": [
{
"name": "source",
"in": "query",
"description": "Optional filter for data source. Use 'Elexon' for Elexon Portal data (ELXP-RMT prefix) or 'MFT' for MFT data (NGET-RMT prefix). If not provided, returns all data points.",
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Requests.DataStatus.RemitDataSource"
},
"example": "Elexon"
},
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"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.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/by-restoration-zone/restored/submissions": {
"get": {
"tags": [
"Demand"
],
"summary": "Restoration Zone Demand Restored Submissions (RZDR)",
"description": "This endpoint provides data about the end of system restoration events. It returns the restored demand value\nfor each restoration zone at the last submission time of each event. The number of events to return is\ndetermined by the `count` parameter.\n \nThe data can be filtered by submission date/time, region, and GSP Group ID (when received by NESO).\n \nAll DateTimes should be expressed as defined within\nRFC 3339.\n\nSome examples of parameter combinations are shown below.\n \nFiltering latest 3 events:\n \n /demand/by-restoration-zone/restored/submissions?count=3\n \nFiltering latest 3 events before a given submission time:\n \n /demand/by-restoration-zone/restored/submissions?before=2025-10-01T00:00Z&count=3\n \nFiltering latest 10 events for a given region:\n \n /demand/by-restoration-zone/restored/submissions?region=North West&count=10",
"parameters": [
{
"name": "count",
"in": "query",
"description": "The number of system restoration events to return.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 3,
"x-max-events-count": 10
},
"example": 3
},
{
"name": "before",
"in": "query",
"description": "If specified, filters events to those with a submission time before or at the specified date and time.\nIf omitted, latest events are returned.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.RestorationZone.RestorationZoneDemandRestoredDatasetRow"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-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"
}
}
}
},
"/demand/outturn": {
"get": {
"tags": [
"Demand"
],
"summary": "Initial National Demand outturn (INDO)",
"description": "This endpoint provides data for Initial National Demand Outturn, which measures the\nhalf-hour average MW demand metered by the Transmission Company based on its operational metering.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective settlement period. The data is represented with:\n- INDO (initial National Demand outturn) which takes into account transmission losses but does not include station transformer load, pumped storage demand or interconnector demand.\n- ITSDO (initial Transmission System Demand outturn) which takes into account transmission losses, station transformer load, pumped storage demand and interconnector demand.\n \nThis endpoint is useful for ad-hoc querying of the data.\n \nSettlement date parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from for the filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to for the filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"name": "settlementPeriod",
"in": "query",
"schema": {
"uniqueItems": true,
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/outturn/stream": {
"get": {
"tags": [
"Demand"
],
"summary": "Initial National Demand outturn (INDO) stream",
"description": "This endpoint provides data for initial National Demand outturn, which measures the\nhalf-hour average MW demand metered by the Transmission Company based on its operational metering.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective settlement period. The data is represented with:\n- INDO (initial National Demand outturn) which takes into account transmission losses but does not include station transformer load, pumped storage demand or interconnector demand.\n- ITSDO (initial Transmission System Demand outturn) which takes into account transmission losses, station transformer load, pumped storage demand and interconnector demand.\n \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data.\n \nSettlement date parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from for the filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to for the filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"name": "settlementPeriod",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/outturn/daily": {
"get": {
"tags": [
"Demand"
],
"summary": "Initial National Demand outturn per day (INDOD)",
"description": "This endpoint provides initial National Demand outturn data per day. The total daily energy volume is the total\ndemand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding\nstation transformer, pumping and interconnector export demand. It is calculated from summing the half hourly\nINDO demands (divided by two to convert to MWh).\n \nIf no date window is chosen, the search will default to results from the last 31 days.\n\nThis API endpoint has a maximum range of 2 years (731 days).",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"example": "2023-08-26"
},
"example": "2023-08-26"
},
{
"name": "settlementDateTo",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"example": "2023-08-27"
},
"example": "2023-08-27"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/outturn/daily/stream": {
"get": {
"tags": [
"Demand"
],
"summary": "Initial National Demand outturn per day (INDOD) stream",
"description": "This endpoint provides initial National Demand outturn daily data. The total daily energy volume is the total\ndemand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding\nstation transformer, pumping and interconnector export demand. It is calculated from summing the half hourly\nINDO demands (divided by two to convert to MWh).\n \nIf no date window is chosen, the search will default to results from the last 31 days.\n\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the data.",
"parameters": [
{
"name": "settlementDateFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"example": "2023-08-26"
},
"example": "2023-08-26"
},
{
"name": "settlementDateTo",
"in": "query",
"schema": {
"type": "string",
"format": "date",
"example": "2023-08-27"
},
"example": "2023-08-27"
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.IndodRow"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/outturn/summary": {
"get": {
"tags": [
"Demand"
],
"summary": "System demand summary (FUELINST)",
"description": "âš This endpoint provides a down-sampled data summary intended for visualisation purposes.\nUse datasets endpoints for full dataset access.",
"parameters": [
{
"name": "resolution",
"in": "query",
"schema": {
"enum": [
"minute",
"hourly",
"daily",
"weekly"
],
"type": "string"
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/peak": {
"get": {
"tags": [
"Demand"
],
"summary": "Peak demand per day (ITSDO)",
"description": "This endpoint allows for retrieving peak ITSDO demand for each day from National Grid ESO.\nResults are filtered by a range of Date parameters.\nResults default to yesterday's peak if no parameters are supplied.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "from",
"in": "query",
"description": "The start of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-01"
},
"example": "2021-10-01"
},
{
"name": "to",
"in": "query",
"description": "The end of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-30"
},
"example": "2021-10-30"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/peak/indicative": {
"get": {
"tags": [
"Demand"
],
"summary": "Indicative peak demand per day (S0142, ITSDO, FUELHH)",
"description": "Indicative demand peaks using operational metering data are daily maxima values determined from\nITSDO and FUELHH data used to determine and visualise Triad.\n \nIndicative demand peaks using settlement metering data are daily maxima values determined from\nmetered volume data from the S0142_bpi file. These peaks are not used for Triad visualisation as\nthey are always calculated based on the latest run type. Triads for settlement data\nremain static after the National Grid report posted at the beginning of April after the Triad season has ended. \n \nIf no filters are supplied, results default to the latest or current Triad season.\nTo specify a custom filter, you can supplier EITHER a Triad season start year, OR a date range, but not both.\nIf a Triad Season Start year is supplied, data for the Triad season beginning on 1 November\nof the specified year will be returned.\nIf a date range is supplied, data will be returned for settlement dates within the date range inclusively.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "data",
"in": "query",
"description": "The type of data. Supports values of 'operational' or 'settlement'.",
"required": true,
"schema": {
"enum": [
"operational",
"settlement"
],
"type": "string",
"example": "operational"
},
"example": "operational"
},
{
"name": "triadSeasonStartYear",
"in": "query",
"description": "A year indicating the Triad season starting on 1 November of the given year, e.g. 2021.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "from",
"in": "query",
"description": "The start of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-01"
},
"example": "2021-10-01"
},
{
"name": "to",
"in": "query",
"description": "The end of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-30"
},
"example": "2021-10-30"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand/peak/indicative/settlement/{triadSeason}": {
"get": {
"tags": [
"Demand"
],
"summary": "Settlement data demand peaks for a Triad season (S0142)",
"description": "Provides indicative demand peak data for a Triad season from S0142_bpi files that were calculated\nduring the Triad season. For the data from the latest settlement runs for the Triad season use the\n`peak/indicative` endpoint.",
"parameters": [
{
"name": "triadSeason",
"in": "path",
"description": "A year indicating the Triad season starting on 1 November of the given year",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 2021
},
"example": 2021
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
}
}
}
}
}
},
"/demand/peak/indicative/operational/{triadSeason}": {
"get": {
"tags": [
"Demand"
],
"summary": "Operational data demand peaks for a Triad season (ITSDO, FUELHH)",
"description": "Provides indicative demand peak data for a Triad season ITSDO and FUELHH files over a Triad season. For non-Triad\nseason dates please use the `peak/indicative` endpoint.",
"parameters": [
{
"name": "triadSeason",
"in": "path",
"description": "A year indicating the Triad season starting on 1 November of the given year",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 2021
},
"example": 2021
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
}
}
}
}
}
},
"/demand/peak/triad": {
"get": {
"tags": [
"Demand"
],
"summary": "Triad demand peaks (S0142, ITSDO, FUELHH)",
"description": "Operational Triad peaks are calculated from the indicative demand peaks data.\n\nSettlement Triad Peaks are calculated from the latest metered volume data available at the point one month following the Triad season's end.\nFor any Triad season still in progress, the latest run type data is used.\n \nAll Triad peaks are at least 10 days clear of one another.",
"parameters": [
{
"name": "data",
"in": "query",
"description": "The type of data. Supports values of 'operational' or 'settlement'.",
"required": true,
"schema": {
"enum": [
"operational",
"settlement"
],
"type": "string",
"example": "operational"
},
"example": "operational"
},
{
"name": "triadSeasonStartYear",
"in": "query",
"description": "A year indicating the Triad season starting on 1 November of the given year.",
"schema": {
"type": "integer",
"format": "int32",
"example": 2021
},
"example": 2021
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/demand": {
"get": {
"tags": [
"Demand"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to demand/outturn.",
"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": "OK"
}
},
"deprecated": true
}
},
"/demand/stream": {
"get": {
"tags": [
"Demand"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to demand/outturn/stream.",
"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": "OK"
}
},
"deprecated": true
}
},
"/demand/rollingSystemDemand": {
"get": {
"tags": [
"Demand"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to generation/outturn.",
"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": "OK"
}
},
"deprecated": true
}
},
"/demand/summary": {
"get": {
"tags": [
"Demand"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to demand/outturn/summary.",
"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": "OK"
}
},
"deprecated": true
}
},
"/demand/total/actual": {
"get": {
"tags": [
"Demand"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to demand/actual/total.",
"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": "OK"
}
},
"deprecated": true
}
},
"/demand/actual/total": {
"get": {
"tags": [
"Demand"
],
"summary": "Actual total load (ATL/B0610)",
"description": "This endpoint provides actual total load data per bidding zone.\nIt can be filtered by settlement period dates.\n \nThis API endpoint has a maximum range of 7 days.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-18"
},
"example": "2023-07-18"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-21"
},
"example": "2023-07-21"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 36
},
"example": 36
},
{
"name": "settlementPeriodTo",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 12
},
"example": 12
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Day-ahead demand forecast (NDF, TSDF)",
"description": "This endpoint provides the day and day ahead demand forecast and are categorized as National Demand Forecast (NDF) and Transmission System Demand Forecast (TSDF);\nthe forecast values are derived by NGESO and is based on historically metered generation output for Great Britain.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nNDF takes into account transmission losses but but does not include station transformer load, pumped storage demand or Interconnector demand;\nthe data is reported only at national level; and TSDF which takes into account transmission losses , station transformer load, pumped storage demand and interconnector demand.\nThe data is reported both at national and boundary (system zones) level. Boundary data only available for Transmission System Demand Forecast (TSDF).",
"parameters": [
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/daily": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Fourteen day demand forecast (NDFD, TSDFD)",
"description": "Retrieve latest 14-day forecast demand data",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
}
}
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/weekly": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "One-year demand forecast (NDFW, TSDFW)",
"description": "This endpoint provides the latest weekly forecast demand data",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
}
}
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/history": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "History of the day-ahead demand forecast (NDF, TSDF)",
"description": "This endpoint provides the day and day ahead demand forecast and are categorized as National Demand Forecast (NDF) and Transmission System Demand Forecast (TSDF);\nthe forecast values are derived by NGESO and is based on historically metered generation output for Great Britain.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nNDF takes into account transmission losses but but does not include station transformer load, pumped storage demand or Interconnector demand;\nthe data is reported only at national level; and TSDF which takes into account transmission losses , station transformer load, pumped storage demand and interconnector demand.\nThe data is reported both at national and boundary (system zones) level. Boundary data only available for Transmission System Demand Forecast (TSDF).",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/daily/history": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "History of the fourteen-day demand forecast (NDFD, TSDFD)",
"description": "Retrieve historical daily forecast demand data",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/weekly/history": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "History of the one-year demand forecast (NDFW, TSDFW)",
"description": "Retrieve historical weekly forecast demand data",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/evolution": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Evolution of the day-ahead demand forecast over time (NDF, TSDF)",
"description": "This endpoint provides the day and day ahead demand forecast and are categorized as National Demand Forecast (NDF) and Transmission System Demand Forecast (TSDF);\nthe forecast values are derived by NGESO and is based on historically metered generation output for Great Britain.\nThe data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period.\nNDF takes into account transmission losses but but does not include station transformer load, pumped storage demand or Interconnector demand;\nthe data is reported only at national level; and TSDF which takes into account transmission losses , station transformer load, pumped storage demand and interconnector demand.\nThe data is reported both at national and boundary (system zones) level. Boundary data only available for Transmission System Demand Forecast (TSDF).\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementPeriod",
"in": "query",
"required": true,
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"example": [
1
]
},
"example": [
1
]
},
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/daily/evolution": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Evolution of the fourteen-day demand forecast over time (NDFD, TSDFD)",
"description": "This endpoint provides the evolution of all daily demand forecasts over time for a given forecast date.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "forecastDate",
"in": "query",
"description": "The forecast date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/weekly/evolution": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Evolution of the one-year demand forecast over time (NDFW, TSDFW)",
"description": "This endpoint provides all weekly demand forecasts over time for a given forecast Year and Week",
"parameters": [
{
"name": "forecastYear",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forecastWeek",
"in": "query",
"required": true,
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/latest": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Historic view of the latest forecasted demand (NDF, TSDF)",
"description": "This endpoint allows for retrieving latest day-ahead demand forecast data from National Grid ESO.\nResults are filtered by settlement time, and only the latest published forecast for each settlement period is shown.",
"parameters": [
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/latest/stream": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Historic view of the latest forecasted demand (NDF, TSDF) stream",
"description": "This endpoint allows for retrieving a stream of latest day-ahead demand forecast data from National Grid ESO.\nResults are filtered by settlement time, and only the latest published forecast for each settlement period is shown.\nThis endpoint has an optimised JSON payload and aimed at frequent request for the day-ahead demand forecast data.",
"parameters": [
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.DayAheadDemandForecastRow"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.DayAheadDemandForecastRow"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.DayAheadDemandForecastRow"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/earliest": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Historic view of the earliest forecasted demand (NDF, TSDF)",
"description": "This endpoint allows for retrieving earliest day-ahead demand forecast data from National Grid ESO.\nResults are filtered by settlement time, and only the earliest published forecast for each settlement period is shown.",
"parameters": [
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/earliest/stream": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Historic view of the earliest forecasted demand (NDF, TSDF) stream",
"description": "This endpoint allows for retrieving a stream of earliest day-ahead demand forecast data from National Grid ESO.\nResults are filtered by settlement time, and only the earliest published forecast for each settlement period is shown.\nThis endpoint has an optimised JSON payload and aimed at frequent request for the day-ahead demand forecast data.",
"parameters": [
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.DayAheadDemandForecastRow"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.DayAheadDemandForecastRow"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.DayAheadDemandForecastRow"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/day-ahead/peak": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Peak forecasted demand per day (TSDF)",
"description": "This endpoint allows for retrieving the peak demand that is forecast for each day from National Grid ESO.\nResults are filtered by a range of Date parameters.\nResults default to yesterday, today and tomorrow if no parameters are supplied.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "boundary",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "The start of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-01"
},
"example": "2021-10-01"
},
{
"name": "to",
"in": "query",
"description": "The end of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-30"
},
"example": "2021-10-30"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/total/day-ahead": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Day-ahead total load forecast (DATL/B0620)",
"description": "This endpoint provides day-ahead total load forecast per bidding zone data.\nIt can be filtered by settlement period dates.\n \nThis API endpoint has a maximum range of 7 days.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-18"
},
"example": "2023-07-18"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-21"
},
"example": "2023-07-21"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 36
},
"example": 36
},
{
"name": "settlementPeriodTo",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 12
},
"example": 12
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/total/week-ahead": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Week-ahead total load forecast (WATL/B0630)",
"description": "This endpoint returns week-ahead total load forecast per bidding zone data with the minimum possible\nand maximum available total loads in MW values, filtered by forecast week.\n \nFor a given forecast date, if more than one forecast has been published, only the most recent forecast\nis returned.\n \nThis API endpoint has a maximum range of 367 days.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "from",
"in": "query",
"description": "The earliest forecast date to include.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2023-08-21"
},
"example": "2023-08-21"
},
{
"name": "to",
"in": "query",
"description": "The latest forecast date to include.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2023-08-27"
},
"example": "2023-08-27"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/demand/total/week-ahead/latest": {
"get": {
"tags": [
"Demand Forecast"
],
"summary": "Latest week-ahead total load forecast (WATL/B0630)",
"description": "This endpoint returns the most recently published WATL / B0630 forecast.\n \nThis forecast is the week-ahead total load forecast per bidding zone data,\nwith minimum possible and maximum available total loads in MW values.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/generation/actual/per-type": {
"get": {
"tags": [
"Generation"
],
"summary": "Historic actual generation automatically down-sampled (AGPT/B1620)",
"description": "âš This endpoint provides a down-sampled data summary intended for visualisation purposes.\nDepending on the quantity of data requested, data returned may be averaged hourly, daily,\nweekly or monthly. Quantities are rounded to the nearest MWh.\nUse /datasets/AGPT for full access.\n \nThis endpoint provides actual aggregated generation data per Power System Resource type \n(Fuel Type categories as defined by Commission Regulation (EU) No 543/2013).\n\nThis endpoint filters by startTime, and groups results by settlement period.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-20"
},
"example": "2023-07-20"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-22"
},
"example": "2023-07-22"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 13
},
"example": 13
},
{
"name": "settlementPeriodTo",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 19
},
"example": 19
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationBySettlementPeriod"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationBySettlementPeriod"
}
}
}
}
}
}
},
"/generation/actual/per-type/day-total": {
"get": {
"tags": [
"Generation"
],
"summary": "Current snapshot of actual generation by fuel type categories (AGPT/B1620)",
"description": "This endpoint provides aggregated AGPT (B1620) data. It returns totals and percentages\nfor the last half hour and 24 hours for each generation type.",
"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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.AgptSummaryData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.AgptSummaryData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.AgptSummaryData"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.AgptSummaryData"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.AgptSummaryData"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.AgptSummaryData"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/generation/actual/per-type/wind-and-solar": {
"get": {
"tags": [
"Generation"
],
"summary": "Historic 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 endpoint filters by startTime and provides a maximum data output range of 7 days.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-18"
},
"example": "2023-07-18"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-21"
},
"example": "2023-07-21"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 36
},
"example": 36
},
{
"name": "settlementPeriodTo",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 12
},
"example": 12
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/generation/outturn/interconnectors": {
"get": {
"tags": [
"Generation"
],
"summary": "Historic half-hourly interconnector flows (FUELINST)",
"description": "This endpoint provides the interconnector flows report derived from the Generation by Fuel Type (FUELINST)\ndata and shows both interconnector imports and exports; the data is updated every five minutes.\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"
}
},
{
"name": "publishDateTimeTo",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "settlementDateFrom",
"in": "query",
"description": "The settlement date from filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementDateTo",
"in": "query",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"name": "settlementPeriod",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "interconnectorName",
"in": "query",
"schema": {
"type": "array",
"items": {
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
}
}
}
}
}
}
},
"/generation/outturn/current": {
"get": {
"tags": [
"Generation"
],
"summary": "Current snapshot of generation by fuel type categories (FUELINST, FUELHH)",
"description": "This endpoint provides a snapshot view of the last 24 hours generation by individual fuel type categories including interconnector.",
"parameters": [
{
"name": "fuelType",
"in": "query",
"schema": {
"type": "array",
"items": {
"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": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.GenerationByFuelType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.GenerationByFuelType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.GenerationByFuelType"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.GenerationByFuelType"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.GenerationByFuelType"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.GenerationByFuelType"
}
}
}
}
}
}
}
},
"/generation/outturn/summary": {
"get": {
"tags": [
"Generation"
],
"summary": "Historic generation automatically down-sampled (FUELINST)",
"description": "âš This endpoint provides a down-sampled data summary intended for visualisation purposes.\nUse raw dataset endpoints under /datasets for full access.",
"parameters": [
{
"name": "startTime",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endTime",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "includeNegativeGeneration",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.OutturnGenerationBySettlementPeriod"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.OutturnGenerationBySettlementPeriod"
}
}
}
}
}
}
}
},
"/generation/outturn/halfHourlyInterconnector": {
"get": {
"tags": [
"Generation"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to generation/outturn/interconnectors.",
"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": "OK"
}
},
"deprecated": true
}
},
"/generation/outturn/FUELINSTHHCUR": {
"get": {
"tags": [
"Generation"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. ",
"description": "This endpoint has been moved to generation/outturn/current.",
"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": "OK"
}
},
"deprecated": true
}
},
"/forecast/availability/daily": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Fourteen-day generation capacity forecast (FOU2T14D)",
"description": "This endpoint provides the latest fourteen-day generation forecast",
"parameters": [
{
"name": "level",
"in": "query",
"description": "The filter level for the forecast. This can be one of the following:\n- `total`: the total forecast for the given time period.\n- `bmUnit`: the forecast for each specified BM unit.\n- `fuelType`: the forecast aggregated, and optionally filtered by fuel type.",
"schema": {
"enum": [
"total",
"fuelType",
"bmUnit"
],
"type": "string",
"example": "fuelType"
},
"example": "fuelType"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM units to query. Add each unit separately. Either the Elexon ID (Eg: `T_CARR-1`) or National Grid ID (Eg: `CARR-1`) can be used.\nBetween 1 and 10 units should be queried when using the `bmUnit` level.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fuelType",
"in": "query",
"description": "The fuel type to query when using the `fuelType` level. 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": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
}
}
}
}
}
},
"/forecast/availability/weekly": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Three-year generation capacity forecast (FOU2T3YW)",
"description": "This endpoint provides the latest three-year generation forecast",
"parameters": [
{
"name": "level",
"in": "query",
"description": "The filter level for the forecast. This can be one of the following:\n- `total`: the total forecast for the given time period.\n- `bmUnit`: the forecast for each specified BM unit.\n- `fuelType`: the forecast aggregated, and optionally filtered by fuel type.",
"schema": {
"enum": [
"total",
"fuelType",
"bmUnit"
],
"type": "string",
"example": "fuelType"
},
"example": "fuelType"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM units to query. Add each unit separately. Either the Elexon ID (Eg: `T_CARR-1`) or National Grid ID (Eg: `CARR-1`) can be used.\nBetween 1 and 10 units should be queried when using the `bmUnit` level.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fuelType",
"in": "query",
"description": "The fuel type to query when using the `fuelType` level. 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": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
}
}
}
}
}
},
"/forecast/availability/daily/history": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "History of the fourteen-day generation capacity forecast (FOU2T14D)",
"description": "This endpoint provides the latest fourteen-day generation forecast from a given DateTime",
"parameters": [
{
"name": "publishTime",
"in": "query",
"description": "The UTC publish time to query. This should be in the format yyyy-MM-ddT:HH:mm:ssZ.",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2024-06-07T15:00:00Z"
},
"example": "2024-06-07T15:00:00Z"
},
{
"name": "level",
"in": "query",
"description": "The filter level for the forecast. This can be one of the following:\n- `total`: the total forecast for the given time period.\n- `bmUnit`: the forecast for each specified BM unit.\n- `fuelType`: the forecast aggregated, and optionally filtered by fuel type.",
"schema": {
"enum": [
"total",
"fuelType",
"bmUnit"
],
"type": "string",
"example": "fuelType"
},
"example": "fuelType"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM units to query. Add each unit separately. Either the Elexon ID (Eg: `T_CARR-1`) or National Grid ID (Eg: `CARR-1`) can be used.\nBetween 1 and 10 units should be queried when using the `bmUnit` level.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fuelType",
"in": "query",
"description": "The fuel type to query when using the `fuelType` level. 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": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
}
}
}
}
}
},
"/forecast/availability/weekly/history": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "History of the three-year generation capacity forecast (FOU2T3YW)",
"description": "This endpoint provides the latest three-year forecast from a given DateTime",
"parameters": [
{
"name": "publishTime",
"in": "query",
"description": "The UTC publish time to query. This should be in the format yyyy-MM-ddT:HH:mm:ssZ.",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2024-06-07T15:00:00Z"
},
"example": "2024-06-07T15:00:00Z"
},
{
"name": "level",
"in": "query",
"description": "The filter level for the forecast. This can be one of the following:\n- `total`: the total forecast for the given time period.\n- `bmUnit`: the forecast for each specified BM unit.\n- `fuelType`: the forecast aggregated, and optionally filtered by fuel type.",
"schema": {
"enum": [
"total",
"fuelType",
"bmUnit"
],
"type": "string",
"example": "fuelType"
},
"example": "fuelType"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM units to query. Add each unit separately. Either the Elexon ID (Eg: `T_CARR-1`) or National Grid ID (Eg: `CARR-1`) can be used.\nBetween 1 and 10 units should be queried when using the `bmUnit` level.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fuelType",
"in": "query",
"description": "The fuel type to query when using the `fuelType` level. 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": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
}
}
}
}
}
},
"/forecast/availability/daily/evolution": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Evolution of the fourteen-day generation capacity forecast over time (FOU2T14D)",
"description": "This endpoint provides the evolution of all daily generation forecasts over time for a given Forecast Date.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "forecastDate",
"in": "query",
"description": "The forecast date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "level",
"in": "query",
"description": "The filter level for the forecast. This can be one of the following:\n- `total`: the total forecast for the given time period.\n- `bmUnit`: the forecast for each specified BM unit.\n- `fuelType`: the forecast aggregated, and optionally filtered by fuel type.",
"schema": {
"enum": [
"total",
"fuelType",
"bmUnit"
],
"type": "string",
"example": "fuelType"
},
"example": "fuelType"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM units to query. Add each unit separately. Either the Elexon ID (Eg: `T_CARR-1`) or National Grid ID (Eg: `CARR-1`) can be used.\nBetween 1 and 10 units should be queried when using the `bmUnit` level.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fuelType",
"in": "query",
"description": "The fuel type to query when using the `fuelType` level. 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": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily"
}
}
}
}
}
}
},
"/forecast/availability/weekly/evolution": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Evolution of the three-year generation capacity forecast over time (FOU2T3YW)",
"description": "This endpoint provides all weekly generation forecasts over time for a given Year and Week",
"parameters": [
{
"name": "year",
"in": "query",
"description": "The forecast year for the filter.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 2024
},
"example": 2024
},
{
"name": "week",
"in": "query",
"description": "The forecast week for the filter.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 17
},
"example": 17
},
{
"name": "level",
"in": "query",
"description": "The filter level for the forecast. This can be one of the following:\n- `total`: the total forecast for the given time period.\n- `bmUnit`: the forecast for each specified BM unit.\n- `fuelType`: the forecast aggregated, and optionally filtered by fuel type.",
"schema": {
"enum": [
"total",
"fuelType",
"bmUnit"
],
"type": "string",
"example": "fuelType"
},
"example": "fuelType"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM units to query. Add each unit separately. Either the Elexon ID (Eg: `T_CARR-1`) or National Grid ID (Eg: `CARR-1`) can be used.\nBetween 1 and 10 units should be queried when using the `bmUnit` level.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fuelType",
"in": "query",
"description": "The fuel type to query when using the `fuelType` level. 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": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
}
}
}
}
}
}
},
"/forecast/generation/day-ahead": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Day-ahead aggregated generation (DAG/B1430)",
"description": "This endpoint provides day-ahead aggregated generation data filtered by settlement date.\n \nThis API endpoint has a maximum range of 7 days.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-20"
},
"example": "2023-07-20"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-22"
},
"example": "2023-07-22"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 13
},
"example": 13
},
{
"name": "settlementPeriodTo",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 19
},
"example": 19
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/generation/wind-and-solar/day-ahead": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Day-ahead generation forecast for wind and solar (DGWS/B1440)",
"description": "This endpoint provides day-ahead forecast generation data for wind and solar.\n \nThis endpoint filters by startTime and provides a maximum data output range of 7 days.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-18"
},
"example": "2023-07-18"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-07-21"
},
"example": "2023-07-21"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 36
},
"example": 36
},
{
"name": "settlementPeriodTo",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 12
},
"example": 12
},
{
"name": "processType",
"in": "query",
"required": true,
"schema": {
"enum": [
"all",
"day ahead",
"intraday process",
"intraday total"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
}
}
}
}
}
}
},
"/forecast/generation/wind": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Current wind generation forecast (WINDFOR)",
"description": "This endpoint provides the latest wind generation forecast data. This provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30. Results are filtered by a range of DateTime parameters.",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
}
}
}
}
}
},
"/forecast/generation/wind/history": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "History of the wind generation forecast (WINDFOR)",
"description": "This endpoint provides the historical wind generation forecast data. This provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
}
}
}
}
}
},
"/forecast/generation/wind/evolution": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Evolution of the wind generation forecast over time (WINDFOR)",
"description": "This endpoint provides the evolution wind generation forecast data.\nThis provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.",
"parameters": [
{
"name": "startTime",
"in": "query",
"required": true,
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
}
}
}
}
}
},
"/forecast/generation/wind/latest": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Historic view of the latest forecasted wind generation (WINDFOR)",
"description": "This endpoint provides the latest wind generation forecast data.\nThis provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
}
}
}
}
}
},
"/forecast/generation/wind/latest/stream": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Historic view of the latest forecasted wind generation (WINDFOR) stream",
"description": "This endpoint provides the latest wind generation forecast data.\nThis provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the wind generation forecast data.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.WindGenerationForecastRow"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.WindGenerationForecastRow"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.WindGenerationForecastRow"
}
}
}
}
}
}
}
},
"/forecast/generation/wind/earliest": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Historic view of the earliest forecasted wind generation (WINDFOR)",
"description": "This endpoint provides the eariest wind generation forecast data.\nThis provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
}
}
}
}
}
},
"/forecast/generation/wind/earliest/stream": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Historic view of the earliest forecasted wind generation (WINDFOR) stream",
"description": "This endpoint provides the earliest wind generation forecast data.\nThis provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.\nThis endpoint has an optimised JSON payload and is aimed at frequent requests for the wind generation forecast data.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.WindGenerationForecastRow"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.WindGenerationForecastRow"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Service.WindGenerationForecastRow"
}
}
}
}
}
}
}
},
"/forecast/generation/wind/peak": {
"get": {
"tags": [
"Generation Forecast"
],
"summary": "Peak wind generation forecast for each day (WINDFOR)",
"description": "This endpoint provides the peak wind generation forecast data.\nThis provides wind generation forecast for wind farms which are visible to the ESO and have operational metering.\nUpdated data is published by NGESO up to 8 times a day at 03:30, 05:30, 08:30, 10:30, 12:30, 16:30, 19:30 and 23:30.\nResults are filtered by a range of DateTime parameters.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "from",
"in": "query",
"description": "The start of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-01"
},
"example": "2021-10-01"
},
{
"name": "to",
"in": "query",
"description": "The end of the requested date range.",
"schema": {
"type": "string",
"format": "date",
"example": "2021-10-30"
},
"example": "2021-10-30"
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast"
}
}
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Health Check"
],
"summary": "Health check",
"description": "This endpoint provides a success response code (200) with status code 2 if the service is alive",
"responses": {
"200": {
"description": "API is healthy"
},
"429": {
"description": "Too many requests"
},
"503": {
"description": "API is unhealthy or in degraded state"
}
}
}
},
"/forecast/indicated/day-ahead": {
"get": {
"tags": [
"Indicated Forecast"
],
"summary": "Latest indicated day-ahead forecast (INDDEM, INDGEN, IMBALNGC, MELNGC)",
"description": "This endpoint provides the latest forecast indicated day-ahead data",
"parameters": [
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
}
}
}
}
}
},
"/forecast/indicated/day-ahead/history": {
"get": {
"tags": [
"Indicated Forecast"
],
"summary": "Historical indicated day-ahead forecast (INDDEM, INDGEN, IMBALNGC, MELNGC)",
"description": "",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
}
}
}
}
}
},
"/forecast/indicated/day-ahead/evolution": {
"get": {
"tags": [
"Indicated Forecast"
],
"summary": "Evolution indicated day-ahead forecast (INDDEM, INDGEN, IMBALNGC, MELNGC)",
"description": "This endpoint provides the forecast indicated day-ahead data over time for the specified settlement date and settlement period.\n\nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "query",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "settlementPeriod",
"in": "query",
"required": true,
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"example": [
1
]
},
"example": [
1
]
},
{
"name": "boundary",
"in": "query",
"description": "Omitting this will return only national data. Specifying boundary=zonal will return only zonal data.",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
}
}
}
}
}
}
},
"/balancing/settlement/messages/{settlementDate}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Settlement messages by settlement date (SMSG)",
"description": "Returns settlement messages generated by the SAA for a given settlement day, relating to the data\nfor a settlement run.\n \nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/messages/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Settlement messages by settlement date and period (SMSG)",
"description": "Returns settlement messages generated by the SAA for a given settlement period, relating to the data\nfor a settlement run.\n \nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementPeriod",
"in": "path",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 3
},
"example": 3
},
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/stack/all/{bidOffer}/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Settlement bid-offer stacks by settlement period (ISPSTACK)",
"description": "Returns detailed system prices generated by the latest calculation run for a given settlement period.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "bidOffer",
"in": "path",
"description": "Filter if bid or offer data is to be returned.",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "settlementPeriod",
"in": "path",
"description": "The settlement period for the filter.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/summary/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Settlement calculation summary (ISPSTACK, DISEBSP, MID, NETBSAD)",
"description": "Returns the settlement calculation summary for the requested settlement period.\nData is derived from the following datasets: ISPSTACK, DISEBSP, MID, NETBSAD\n \nIn JSON format, decimal values are returned as strings to avoid loss of precision.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "settlementPeriod",
"in": "path",
"description": "This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 1
},
{
"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.Balancing.Settlement.SettlementSummaryResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"404": {
"description": "No data found for the requested parameters"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/default-notices": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Default notices (CDN)",
"description": "This endpoint provides a subset of CDN (Credit Default Notice) data received from ECVAA (Energy Contract Volume Aggregation Agent). It returns the defaults that are in force and defaults that have closed within the last 7 days.",
"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.Balancing.CreditDefaultNoticeResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/system-prices/{settlementDate}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Settlement system prices by settlement date (DISEBSP)",
"description": "Returns settlement system buy and sell prices generated by the SAA for a given settlement day, relating to\nthe data for a settlement run.\n \nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/system-prices/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Settlement system prices by settlement date and period (DISEBSP)",
"description": "Returns settlement system buy and sell prices generated by the SAA for a given settlement period, relating to\nthe data for a settlement run.\n \nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementPeriod",
"in": "path",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 1
},
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date to filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/acceptance/volumes/all/{bidOffer}/{settlementDate}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Acceptance volumes by settlement date (BOAV)",
"description": "Returns the settlement acceptance volumes for the requested settlement date.\n\nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "bidOffer",
"in": "path",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "bmUnit",
"in": "query",
"description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"DALSW-1"
]
},
"example": [
"DALSW-1"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/acceptance/volumes/all/{bidOffer}/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Acceptance volumes by settlement period (BOAV)",
"description": "Returns the settlement acceptance volumes for the requested settlement period.\n\nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementPeriod",
"in": "path",
"description": "This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 48
},
"example": 48
},
{
"name": "settlementDate",
"in": "path",
"description": "This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "bidOffer",
"in": "path",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "bmUnit",
"in": "query",
"description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"DALSW-1"
]
},
"example": [
"DALSW-1"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/indicative/volumes/all/{bidOffer}/{settlementDate}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Indicative volumes by settlement date (DISPTAV)",
"description": "Returns the settlement indicative volumes for the requested settlement date.\n\nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "bidOffer",
"in": "path",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "bmUnit",
"in": "query",
"description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2__CMRCY001"
]
},
"example": [
"2__CMRCY001"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/indicative/volumes/all/{bidOffer}/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Indicative volumes by settlement period (DISPTAV)",
"description": "Returns the settlement indicative volumes for the requested settlement period.\n\nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementPeriod",
"in": "path",
"description": "This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
},
{
"name": "settlementDate",
"in": "path",
"description": "This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "bidOffer",
"in": "path",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "bmUnit",
"in": "query",
"description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2__CMRCY001"
]
},
"example": [
"2__CMRCY001"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/indicative/cashflows/all/{bidOffer}/{settlementDate}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Indicative period BMU cashflows by settlement date (EBOCF)",
"description": "Returns derived indicative cashflow data generated by the latest calculation run for a given settlement date.\n \nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "bidOffer",
"in": "path",
"description": "Filter if bid or offer data is to be returned.",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"T_DINO-2"
]
},
"example": [
"T_DINO-2"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/indicative/cashflows/all/{bidOffer}/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Indicative period BMU cashflows by settlement period (EBOCF)",
"description": "Returns derived indicative cashflow data generated by the latest calculation run for a given settlement period.\n \nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementPeriod",
"in": "path",
"description": "The settlement period for the filter.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 9
},
"example": 9
},
{
"name": "bidOffer",
"in": "path",
"description": "Filter if bid or offer data is to be returned.",
"required": true,
"schema": {
"enum": [
"bid",
"offer"
],
"type": "string",
"example": "bid"
},
"example": "bid"
},
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "bmUnit",
"in": "query",
"description": "The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"T_DINO-2"
]
},
"example": [
"T_DINO-2"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/acceptances/all/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Historic acceptances by settlement period (ISPSTACK, BOALF, BOD)",
"description": "Returns the bid and offer prices for acceptances, with the acceptance number and acceptance time. Results are sorted by descending acceptance time.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"name": "settlementPeriod",
"in": "path",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/market-depth/{settlementDate}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Market depth by settlement date (IMBALNGC, BOD, DISEBSP, DISPTAV)",
"description": "Returns market depth data for a given day.\nImbalance (MW) is retrieved from IMBALNGC.\nBid/offer volumes (MWh) are calculated by summing bid/offer volumes from BOD.\nTotal acceptance volumes (MWh) are retrieved from DISEBSP.\nPriced acceptance volumes (MWh) are calculated by summing bid/offer accepted volumes with data type Original from DISPTAV.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/settlement/market-depth/{settlementDate}/{settlementPeriod}": {
"get": {
"tags": [
"Indicative Imbalance Settlement"
],
"summary": "Market depth by settlement period (IMBALNGC, BOD, DISEBSP, DISPTAV)",
"description": "Returns market depth data for a given settlement period.\nImbalance (MW) is retrieved from IMBALNGC.\nBid/offer volumes (MWh) are calculated by summing bid/offer volumes from BOD.\nTotal acceptance volumes (MWh) are retrieved from DISEBSP.\nPriced acceptance volumes (MWh) are calculated by summing bid/offer accepted volumes with data type Original from DISPTAV.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "settlementPeriod",
"in": "path",
"description": "The settlement period to filter. This should be an integer from 1-50 inclusive.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 1
},
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2024-02-01"
},
"example": "2024-02-01"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/interop/MessageListRetrieval": {
"get": {
"tags": [
"Legacy"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. Use /remit/* or /datasets/REMIT endpoints instead.",
"parameters": [
{
"name": "eventStart",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-08-01"
},
"example": "2023-08-01"
},
{
"name": "eventEnd",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-08-02"
},
"example": "2023-08-02"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitListResponse"
}
}
}
}
},
"deprecated": true
}
},
"/interop/MessageDetailRetrieval": {
"get": {
"tags": [
"Legacy"
],
"summary": "This endpoint is obsolete, and this location may be removed with no further notice. Use /remit/* or /datasets/REMIT endpoints instead.",
"parameters": [
{
"name": "messageId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"example": "2023060105000001-ELXP-RMT-20230601"
},
"example": "2023060105000001-ELXP-RMT-20230601"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitDetailResponse"
}
}
}
}
},
"deprecated": true
}
},
"/lss/load-shape-period": {
"get": {
"tags": [
"Load Shape"
],
"summary": "Load shape period data (IF022)",
"description": "This endpoint enables the retrieval of load shape period (IF022) data for a specified date and settlement period range.\n\nFor more information on Load shape data & load shape categories please view the\nLSS method statement.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "date",
"in": "query",
"description": "The settlement date to return load shape period data for. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-01"
},
"example": "2026-03-01"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"description": "Optional settlement period range start (inclusive).",
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 1
},
{
"name": "settlementPeriodTo",
"in": "query",
"description": "Optional settlement period range end (inclusive).",
"schema": {
"type": "integer",
"format": "int32",
"example": 10
},
"example": 10
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
}
}
},
"400": {
"description": "Error with query parameters - see response for details"
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/lss/load-shape-period/stream": {
"get": {
"tags": [
"Load Shape"
],
"summary": "Load shape period data stream (IF022)",
"description": "This endpoint provides a stream of load shape period (IF022) data for a specified date and settlement period range.\nFor more information on Load shape data & load shape categories please view the\nLSS method statement.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "The settlement date range start (inclusive). This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-01"
},
"example": "2026-03-01"
},
{
"name": "toDate",
"in": "query",
"description": "The settlement date range end (inclusive). This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-02"
},
"example": "2026-03-02"
},
{
"name": "settlementPeriodFrom",
"in": "query",
"description": "Optional settlement period range start (inclusive).",
"schema": {
"type": "integer",
"format": "int32",
"example": 40
},
"example": 40
},
{
"name": "settlementPeriodTo",
"in": "query",
"description": "Optional settlement period range end (inclusive).",
"schema": {
"type": "integer",
"format": "int32",
"example": 2
},
"example": 2
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapePeriodData"
}
}
}
}
},
"400": {
"description": "Error with query parameters - see response for details"
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/lss/load-shape-totals": {
"get": {
"tags": [
"Load Shape"
],
"summary": "Load shape totals data (IF023)",
"description": "This endpoint enables the retrieval of Load shape totals data (IF023) for a specified settlement day.\nFor more information on Load shape data & load shape categories please view the\nLSS method statement.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "The settlement date range start (inclusive). This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-01"
},
"example": "2026-03-01"
},
{
"name": "toDate",
"in": "query",
"description": "The settlement date range end (inclusive). This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-31"
},
"example": "2026-03-31"
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
}
}
},
"400": {
"description": "Error with query parameters - see response for details"
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/lss/load-shape-totals/stream": {
"get": {
"tags": [
"Load Shape"
],
"summary": "Load shape totals data stream (IF023)",
"description": "This endpoint provides a stream of load shape totals (IF023) data for a specified date range.\nFor more information on Load shape data & load shape categories please view the\nLSS method statement.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "The settlement date range start (inclusive). This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-01"
},
"example": "2026-03-01"
},
{
"name": "toDate",
"in": "query",
"description": "The settlement date range end (inclusive). This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-31"
},
"example": "2026-03-31"
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
}
}
}
}
},
"400": {
"description": "Error with query parameters - see response for details"
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/lolpdrm/forecast/evolution": {
"get": {
"tags": [
"Loss of Load Probability and De-rated Margin"
],
"summary": "Loss of load probability and de-rated margin forecast (LOLPDRM)",
"description": "This endpoint has been moved to forecast/system/loss-of-load.",
"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": "OK"
}
},
"deprecated": true
}
},
"/forecast/margin/daily": {
"get": {
"tags": [
"Margin Forecast"
],
"summary": "Daily margin forecast (OCNMFD2)",
"description": "This endpoint provides the Generating Plant Operating Margin covering 2 days ahead to 14 days ahead\nin MW values. The Daily API outputs the latest published data for daily margin forecast for D+2 t D+14",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
}
}
}
}
}
},
"/forecast/margin/daily/history": {
"get": {
"tags": [
"Margin Forecast"
],
"summary": "Historical daily margin forecast (OCNMFD2)",
"description": "This endpoint provides the historic Generating Plant Operating Margin covering 2 days ahead to 14 days ahead in MW values.\nThe historic API outputs the latest published data for historic daily margin forecast for D+2 to D+14",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
}
}
}
}
}
},
"/forecast/margin/daily/evolution": {
"get": {
"tags": [
"Margin Forecast"
],
"summary": "Evolution daily margin forecast (OCNMFD2)",
"description": "This endpoint provides the daily evolution Generating Plant Operating Margin covering 2 days ahead to 14 days ahead in MW values.\nThe Daily API outputs the latest published data for daily margin forecast for D+2 to D+14.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "forecastDate",
"in": "query",
"description": "The forecast date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
}
}
}
}
}
}
},
"/forecast/margin/weekly": {
"get": {
"tags": [
"Margin Forecast"
],
"summary": "Weekly margin forecast (OCNMFW2, OCNMF3Y2)",
"description": "This endpoint provides the Generating Plant Operating Margin covering 2 weeks ahead to 156 weeks ahead in MW values.\nThe weekly API outputs the latest published data for weekly margin forecast for W+2 to W+156",
"parameters": [
{
"name": "range",
"in": "query",
"schema": {
"enum": [
"52W",
"156W"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
}
}
}
}
}
},
"/forecast/margin/weekly/history": {
"get": {
"tags": [
"Margin Forecast"
],
"summary": "Historical weekly margin forecast (OCNMFW2, OCNMF3Y2)",
"description": "This endpoint provides the weekly historic Generating Plant Operating Margin.\nThis historic API output 2 weeks ahead to 156 weeks ahead in MW values",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "range",
"in": "query",
"schema": {
"enum": [
"52W",
"156W"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
}
}
}
}
}
},
"/forecast/margin/weekly/evolution": {
"get": {
"tags": [
"Margin Forecast"
],
"summary": "Evolution daily margin forecast (OCNMFW2, OCNMF3Y2)",
"description": "This endpoint provides the daily evolution Generating Plant Operating Margin covering 2 days ahead to 14 days ahead in MW values.\nThe Daily API outputs the latest published data for daily margin forecast for D+2 t D+14",
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "week",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "range",
"in": "query",
"schema": {
"enum": [
"52W",
"156W"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
}
}
}
}
}
}
},
"/balancing/pricing/market-index": {
"get": {
"tags": [
"Market Index"
],
"summary": "Market Index Data (MID) price time series",
"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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/pricing/market-index?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/pricing/market-index?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to start time:\n \n /balancing/pricing/market-index?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 /balancing/pricing/market-index?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-13T00:00Z"
},
"example": "2022-10-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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/stor": {
"get": {
"tags": [
"Non-BM STOR"
],
"summary": "Non-BM STOR time series (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 \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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/nonbm/stor?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/nonbm/stor?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to start time:\n \n /balancing/nonbm/stor?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 /balancing/nonbm/stor?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-06-01T00:00Z",
"x-max-day-range-including-zeroes": 31,
"x-max-day-range-excluding-zeroes": 3653
},
"example": "2022-06-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-07-01T00:00Z"
},
"example": "2022-07-01T00: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": "includeZero",
"in": "query",
"description": "Include data points with a generation of zero.",
"schema": {
"type": "boolean",
"example": false
},
"example": false
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/stor/events": {
"get": {
"tags": [
"Non-BM STOR"
],
"summary": "Non-BM STOR events (NONBM)",
"description": "This endpoint provides data about the start of NGESO Short Term Operating Reserves (STOR) events. This is\nactivity that is outside of the Balancing Mechanism and takes place to meet the need to\nincrease generation or decrease demand. Each result has a non-zero generation value which was preceded by a zero\ngeneration value.\n \nBy default, the before parameter filters the data by start time. If the settlementPeriodBefore parameter is\nprovided, the before parameter instead filters on settlement date, allowing for searching by start time or\nsettlement date & settlement period.\nNote: When filtering via settlement date, before is treated as a Date 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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering latest 3 events:\n \n /balancing/nonbm/stor/events?count=3\n \nFiltering latest 3 events before start time:\n \n /balancing/nonbm/stor/events?before=2022-08-01T00:00Z&count=3\n \nFiltering latest 3 events before settlement date and settlement period:\n \n /balancing/nonbm/stor/events?before=2022-08-01T00:00Z&settlementPeriodBefore=48&count=3",
"parameters": [
{
"name": "count",
"in": "query",
"description": "The number of events to return.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 3,
"x-max-event-count": 100
},
"example": 3
},
{
"name": "before",
"in": "query",
"description": "If specified, filters events to those with a start time before or at the date, or a settlement date before the date if\nsettlementPeriodBefore is also specified.\nIf omitted, latest events are returned.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "settlementPeriodBefore",
"in": "query",
"description": "Filters events to those with a settlement period before or at the value.\nBefore parameter must be specified if this is specified.",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/balancing/nonbm/volumes": {
"get": {
"tags": [
"Non-BM Volumes"
],
"summary": "Balancing services volume (QAS)",
"description": "This endpoint provides balancing services volume data received from NGESO, with an added computed 'Time' field.\n(The time field is calculated from the settlement date & period and represents the earliest possible time for\nfor which the datapoint applies)\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\nRFC 3339.\n \nSome examples of date parameter combinations are shown below.\n \nFiltering from start time to start time:\n \n /balancing/nonbm/volumes?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z\n \nFiltering from start time to settlement date and period:\n \n /balancing/nonbm/volumes?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1\n \nFiltering from settlement date and period to start time:\n \n /balancing/nonbm/volumes?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 /balancing/nonbm/volumes?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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/reference/fueltypes/all": {
"get": {
"tags": [
"Reference"
],
"summary": "Fuel types",
"description": "This endpoint provides a current list of fuel types",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/reference/remit/participants/all": {
"get": {
"tags": [
"Reference"
],
"summary": "Participants",
"description": "This endpoint provides a current list of participant IDs received from REMIT messages",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/reference/remit/assets/all": {
"get": {
"tags": [
"Reference"
],
"summary": "Assets",
"description": "This endpoint provides a current list of asset IDs received from REMIT messages",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/reference/remit/fueltypes/all": {
"get": {
"tags": [
"Reference"
],
"summary": "REMIT fuel types",
"description": "This endpoint provides a current list of fuel types received from REMIT messages",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/reference/bmunits/all": {
"get": {
"tags": [
"Reference"
],
"summary": "BM Units",
"description": "This endpoint provides a current list of BM units held by Elexon",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
}
}
}
}
}
},
"/reference/bmunits": {
"get": {
"tags": [
"Reference"
],
"summary": "BM Units (filtered)",
"description": "This endpoint provides a list of BM units filtered by lead party IDs.\n \nThe PartyIds query parameter is required. Provide one or more lead party IDs to filter the results.",
"parameters": [
{
"name": "partyIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ADELA",
"LENCO"
]
},
"example": [
"ADELA",
"LENCO"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.BmUnitData"
}
}
}
}
}
}
}
},
"/reference/interconnectors/all": {
"get": {
"tags": [
"Reference"
],
"summary": "Interconnectors",
"description": "This endpoint provides a current list of interconnectors",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.InterconnectorData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.InterconnectorData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.InterconnectorData"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.InterconnectorData"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.InterconnectorData"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Reference.InterconnectorData"
}
}
}
}
}
}
}
},
"/remit": {
"get": {
"tags": [
"REMIT"
],
"summary": "Bulk fetch message details by IDs",
"description": "This endpoint provides one or more REMIT messages based on the given message IDs.",
"parameters": [
{
"name": "messageId",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"example": [
1,
2,
3,
4
]
},
"example": [
1,
2,
3,
4
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"404": {
"description": "No data found for given query parameters"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/{messageId}": {
"get": {
"tags": [
"REMIT"
],
"summary": "Fetch message details by ID",
"description": "This endpoint provides a REMIT message based on a given message ID.",
"parameters": [
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"404": {
"description": "No data found for given id"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/search": {
"get": {
"tags": [
"REMIT"
],
"summary": "Fetch message details by mRID",
"description": "This endpoint provides one or more REMIT messages based on the given mRID and revision number. If none is given\nit returns the REMIT message revision with the latest revision number.",
"parameters": [
{
"name": "mrid",
"in": "query",
"required": true,
"schema": {
"type": "string",
"example": "48X000000000080X-NGET-RMT-00014669"
},
"example": "48X000000000080X-NGET-RMT-00014669"
},
{
"name": "revisionNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"404": {
"description": "No data found for given query parameters"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/revisions": {
"get": {
"tags": [
"REMIT"
],
"summary": "List all message revisions",
"description": "This endpoint provides all revisions for a given REMIT message.\nThe message can be specified in two ways:\n- the mRID\n- the message ID of a specific revision, which will return the entire list of revisions for that message",
"parameters": [
{
"name": "mrid",
"in": "query",
"schema": {
"type": "string",
"example": "48X000000000080X-NGET-RMT-00014669"
},
"example": "48X000000000080X-NGET-RMT-00014669"
},
{
"name": "messageId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"example": 1
},
"example": 1
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"404": {
"description": "No data found for given query parameters"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/list/by-publish": {
"get": {
"tags": [
"REMIT"
],
"summary": "List messages by publish time",
"description": "This endpoint provides a list of REMIT message identifiers based on the publish time and other optional parameters.\n \n- Filtering by LatestRevisionOnly (default = true):\n if true, include only the latest revision of each message.\n \n- Filtering by ProfileOnly (default = false):\n if true, include only messages with an outage profile.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/13 07:00"
},
"example": "2023/04/13 07:00"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/14 07:00"
},
"example": "2023/04/14 07:00"
},
{
"name": "participantId",
"in": "query",
"schema": {
"type": "string",
"example": "EECL"
},
"example": "EECL"
},
{
"name": "assetId",
"in": "query",
"schema": {
"type": "string",
"example": "T_RATSGT-2"
},
"example": "T_RATSGT-2"
},
{
"name": "messageType",
"in": "query",
"schema": {
"type": "string",
"example": "UnavailabilitiesOfElectricityFacilities"
},
"example": "UnavailabilitiesOfElectricityFacilities"
},
{
"name": "unavailabilityType",
"in": "query",
"schema": {
"type": "string",
"example": "Planned"
},
"example": "Planned"
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
{
"name": "fuelType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
{
"name": "latestRevisionOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": true
},
"example": true
},
{
"name": "profileOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": false
},
"example": false
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/list/by-publish/stream": {
"get": {
"tags": [
"REMIT"
],
"summary": "List messages by publish time (stream)",
"description": "This endpoint provides a list of REMIT message identifiers based on the publish time and other optional parameters.\n \n- Filtering by LatestRevisionOnly (default = true):\n if true, include only the latest revision of each message.\n \n- Filtering by ProfileOnly (default = false):\n if true, include only messages with an outage profile.\n \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for this data.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/13 07:00"
},
"example": "2023/04/13 07:00"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/14 07:00"
},
"example": "2023/04/14 07:00"
},
{
"name": "participantId",
"in": "query",
"schema": {
"type": "string",
"example": "EECL"
},
"example": "EECL"
},
{
"name": "assetId",
"in": "query",
"schema": {
"type": "string",
"example": "T_RATSGT-2"
},
"example": "T_RATSGT-2"
},
{
"name": "messageType",
"in": "query",
"schema": {
"type": "string",
"example": "UnavailabilitiesOfElectricityFacilities"
},
"example": "UnavailabilitiesOfElectricityFacilities"
},
{
"name": "unavailabilityType",
"in": "query",
"schema": {
"type": "string",
"example": "Planned"
},
"example": "Planned"
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
{
"name": "fuelType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
{
"name": "latestRevisionOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": true
},
"example": true
},
{
"name": "profileOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": false
},
"example": false
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/list/by-event": {
"get": {
"tags": [
"REMIT"
],
"summary": "List messages by event time",
"description": "This endpoint provides a list of REMIT message identifiers based on the event start time, end time and other optional parameters.\n \n- Filtering by LatestRevisionOnly (default = true):\n if true, include only the latest revision of each message.\n \n- Filtering by ProfileOnly (default = false):\n if true, include only messages with an outage profile.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/13 07:00"
},
"example": "2023/04/13 07:00"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/14 07:00"
},
"example": "2023/04/14 07:00"
},
{
"name": "participantId",
"in": "query",
"schema": {
"type": "string",
"example": "EECL"
},
"example": "EECL"
},
{
"name": "assetId",
"in": "query",
"schema": {
"type": "string",
"example": "T_RATSGT-2"
},
"example": "T_RATSGT-2"
},
{
"name": "messageType",
"in": "query",
"schema": {
"type": "string",
"example": "UnavailabilitiesOfElectricityFacilities"
},
"example": "UnavailabilitiesOfElectricityFacilities"
},
{
"name": "unavailabilityType",
"in": "query",
"schema": {
"type": "string",
"example": "Planned"
},
"example": "Planned"
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
{
"name": "fuelType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
{
"name": "latestRevisionOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": true
},
"example": true
},
{
"name": "profileOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": false
},
"example": false
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/remit/list/by-event/stream": {
"get": {
"tags": [
"REMIT"
],
"summary": "List messages by event time (stream)",
"description": "This endpoint provides a list of REMIT message identifiers based on the event start, end time and other optional parameters.\n \n- Filtering by LatestRevisionOnly (default = true):\n if true, include only the latest revision of each message.\n \n- Filtering by ProfileOnly (default = false):\n if true, include only messages with an outage profile.\n \nThis endpoint has an optimised JSON payload and is aimed at frequent requests for this data.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/13 07:00"
},
"example": "2023/04/13 07:00"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023/04/14 07:00"
},
"example": "2023/04/14 07:00"
},
{
"name": "participantId",
"in": "query",
"schema": {
"type": "string",
"example": "EECL"
},
"example": "EECL"
},
{
"name": "assetId",
"in": "query",
"schema": {
"type": "string",
"example": "T_RATSGT-2"
},
"example": "T_RATSGT-2"
},
{
"name": "messageType",
"in": "query",
"schema": {
"type": "string",
"example": "UnavailabilitiesOfElectricityFacilities"
},
"example": "UnavailabilitiesOfElectricityFacilities"
},
{
"name": "unavailabilityType",
"in": "query",
"schema": {
"type": "string",
"example": "Planned"
},
"example": "Planned"
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
"example": [
"Production Unavailability",
"Transmission unavailability"
]
},
{
"name": "fuelType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
"example": [
"Fossil Hard coal",
"Biomass"
]
},
{
"name": "latestRevisionOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": true
},
"example": true
},
{
"name": "profileOnly",
"in": "query",
"schema": {
"type": "boolean",
"example": false
},
"example": false
}
],
"responses": {
"200": {
"description": "Data retrieved",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
}
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/generation/outturn": {
"get": {
"tags": [
"Generation",
"Rolling System Demand"
],
"summary": "Total generation outturn (FUELINST)",
"description": "This endpoint provides the total generation outturn across all fuel types, derived by summing generation\nof all categories from the Generation by Fuel Type report.\n \nThis data can be used as a proxy for rolling system demand.",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/saa/datasets/total-exempt-volume/{settlementDate}": {
"get": {
"tags": [
"SAA Datasets"
],
"summary": "Total Exempt Supply Volume (S0621)",
"description": "Returns the total Import and Export Exempt Metered Volume (in MWh) for the requested settlement date and settlement run type.\n \nThis endpoint will not return any data until S0621 data is first published at the beginning of March 2025.\n\nSettlement date parameter must be provided in the exact format YYYY-MM-dd.",
"parameters": [
{
"name": "settlementDate",
"in": "path",
"description": "The settlement date for the filter.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2025-02-27"
},
"example": "2025-02-27"
},
{
"name": "settlementRunType",
"in": "query",
"description": "The settlement run type for the filter.\nIf one or more run types are specified, only data with those run types is returned.\nIf no run type is specified, for each settlement period only the single data point with the most recent run type is returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"II",
"SF"
]
},
"example": [
"II",
"SF"
]
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/soso/prices": {
"get": {
"tags": [
"SO-SO Prices"
],
"summary": "SO-SO prices (SOSO)",
"description": "This endpoint provides system operator to system operator prices data.\nIt can be filtered by start time.\n \nThis API endpoint has a maximum range of 24 hours.",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-09-26T07:00:00Z"
},
"example": "2023-09-26T07:00:00Z"
},
{
"name": "to",
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices"
}
}
}
},
"429": {
"description": "Too many requests"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/forecast/surplus/daily": {
"get": {
"tags": [
"Surplus Forecast"
],
"summary": "Daily surplus forecast (OCNMFD)",
"description": "This endpoint provides the Generating Plant Operating Surplus covering 2 days ahead to 14 days ahead in MW values.\nThe Daily API outputs the latest published data for daily surplus forecast for D+2 t D+14",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
}
}
}
}
}
},
"/forecast/surplus/daily/history": {
"get": {
"tags": [
"Surplus Forecast"
],
"summary": "Historical daily surplus forecast (OCNMFD)",
"description": "This endpoint provides the historic Generating Plant Operating Surplus covering 2 days ahead to 14 days ahead in MW values.\nThe historic API outputs the latest published data for historic daily surplus forecast for D+2 to D+14",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
}
}
}
}
}
},
"/forecast/surplus/daily/evolution": {
"get": {
"tags": [
"Surplus Forecast"
],
"summary": "Evolution daily surplus forecast (OCNMFD)",
"description": "This endpoint provides the daily evolution Generating Plant Operating Surplus covering 2 days ahead to 14 days ahead in MW values.\nThe Daily API outputs the latest published data for daily surplus forecast for D+2 to D+14.\n \nDate parameter must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "forecastDate",
"in": "query",
"description": "The forecast date for the filter. This must be in the format yyyy-MM-dd.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
}
}
}
}
}
}
},
"/forecast/surplus/weekly": {
"get": {
"tags": [
"Surplus Forecast"
],
"summary": "Weekly surplus forecast (OCNMFW, OCNMF3Y)",
"description": "This endpoint provides the Generating Plant Operating Surplus covering 2 weeks ahead to 156 weeks ahead in MW values.\nThe weekly API outputs the latest published data for weekly surplus forecast for W+2 to W+156",
"parameters": [
{
"name": "range",
"in": "query",
"schema": {
"enum": [
"52W",
"156W"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
}
}
}
}
}
},
"/forecast/surplus/weekly/history": {
"get": {
"tags": [
"Surplus Forecast"
],
"summary": "Historical weekly surplus forecast (OCNMFW, OCNMF3Y)",
"description": "This endpoint provides the historic Generating Plant Operating Surplus covering 2 weeks ahead to 156 weeks ahead in MW values.\nThe weekly API outputs the latest published data for weekly surplus forecast for W+2 to W+156.\nHistorical published data of weekly surplus forecasts for a given publish date in the 2-156 week dataset.",
"parameters": [
{
"name": "publishTime",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "range",
"in": "query",
"schema": {
"enum": [
"52W",
"156W"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
}
}
}
}
}
},
"/forecast/surplus/weekly/evolution": {
"get": {
"tags": [
"Surplus Forecast"
],
"summary": "Evolution weekly surplus forecast (OCNMFW, OCNMF3Y)",
"description": "This endpoint provides the evolution Generating Plant Operating Surplus covering 2 weeks ahead to 156 weeks ahead in MW values.\nThe weekly API outputs the latest published data for weekly surplus forecast for W+2 to W+156",
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "week",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "range",
"in": "query",
"schema": {
"enum": [
"52W",
"156W"
],
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
}
}
}
}
}
}
},
"/system/frequency": {
"get": {
"tags": [
"System"
],
"summary": "System frequency (FREQ)",
"description": "This endpoint allows for retrieving a collection of recent system frequency data from National Grid ESO. Results\ncan be filtered by a range of DateTime parameters. This endpoint is useful for ad-hoc querying frequency data.",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency"
}
}
}
}
}
}
},
"/system/frequency/stream": {
"get": {
"tags": [
"System"
],
"summary": "System frequency (FREQ) stream",
"description": "This endpoint allows for retrieving a stream of recent system frequency data from National Grid ESO. Results can\nbe filtered by a range of DateTime parameters. This endpoint has an optimised JSON payload and aimed at frequent\nrequest for the frequency data.",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.SystemFrequency"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.SystemFrequency"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.SystemFrequency"
}
}
}
}
}
}
}
},
"/system/warnings": {
"get": {
"tags": [
"System"
],
"summary": "System warnings (SYSWARN)",
"description": "This endpoint provides system warnings data. Results can be filtered by warning type and a range of DateTime parameters.\n- If no parameters are specified then the latest message is returned\n- If just a warning type is specified then the latest message of that type is returned\n- If just publish times are specified then all messages within that range are returned",
"parameters": [
{
"name": "warningType",
"in": "query",
"schema": {
"type": "string",
"example": "IT SYSTEMS OUTAGE"
},
"example": "IT SYSTEMS OUTAGE"
},
{
"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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData"
}
}
}
}
}
}
},
"/system/demand-control-instructions": {
"get": {
"tags": [
"System"
],
"summary": "Demand control instructions (DCI)",
"description": "This endpoint provides demand control instruction data, filtered by the time range of the instruction.\nThere is no date range limit on parameters.\nIf no query parameters are supplied all data is returned.",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"example": "2021-04-30T00:00Z"
},
"example": "2021-04-30T00:00Z"
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"example": "2021-04-30T20:00Z"
},
"example": "2021-04-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": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
}
}
}
}
}
}
},
"/forecast/system/loss-of-load": {
"get": {
"tags": [
"System forecast"
],
"summary": "Loss of load probability and de-rated margin forecast (LOLPDRM)",
"description": "This endpoint provides the 1h, 2h, 4h, 8h and 12h+ Loss of Load Probability and De-rated Margin forecasts\nfor each settlement period over a requested time range.\n \nFor each forecast horizon at 1, 2, 4 or 8 hours, the returned value is the forecast received that number of hours\nbefore the start of the settlement period.\n \nFor the forecast horizon of 12h, the returned value is the most recent forecast received 12 or more hours\nbefore the start of the settlement period. That is, if the most recent forecast was published today at 00:00,\n- for 11:30 today, the 12h forecast is the one published yesterday at 23:30 (12h before)\n- for 12:00 today, the 12h forecast is the one published today at 00:00 (12h before)\n- for 12:30 today, the 12h forecast is the one published today at 00:00 (the latest published)",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-03-06T07:00Z"
},
"example": "2023-03-06T07:00Z"
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2023-03-06T12:00Z"
},
"example": "2023-03-06T12: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",
"example": 15
},
"example": 15
},
{
"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": 25
},
"example": 25
},
{
"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.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
}
}
}
},
"429": {
"description": "Too many requests"
},
"400": {
"description": "Error with query parameters - see response for details"
},
"500": {
"description": "Server error - please try again later"
}
}
}
},
"/temperature": {
"get": {
"tags": [
"Temperature"
],
"summary": "Temperature data (TEMP)",
"description": "This endpoint provides daily average GB temperature data (in Celsius) as well as reference temperatures (low, normal and high).\nThis average data is calculated by National Grid ESO from the data retrieved from 6 weather stations around Britain.\nNGESO use this data as part of the electricity demand forecasting process.\n \nDate parameters must be provided in the exact format yyyy-MM-dd.",
"parameters": [
{
"name": "from",
"in": "query",
"description": "The from date for the filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-20"
},
"example": "2022-09-20"
},
{
"name": "to",
"in": "query",
"description": "The to date for the filter. This must be in the format yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2022-09-21"
},
"example": "2022-09-21"
},
{
"name": "format",
"in": "query",
"description": "Response data format. Use json/xml to include metadata.",
"schema": {
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Insights.Api.LegacyInteroperability.LegacyRemitDetailBody": {
"type": "object",
"properties": {
"dataItem": {
"type": "string",
"nullable": true
},
"list": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitDetailList"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitDetailItem": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"nullable": true
},
"sequenceId": {
"type": "integer",
"format": "int32"
},
"messageHeading": {
"type": "string",
"nullable": true
},
"eventType": {
"type": "string",
"nullable": true
},
"publishDateTimeString": {
"type": "string",
"nullable": true
},
"participantMarketParticipantId": {
"type": "string",
"nullable": true
},
"assetId": {
"type": "string",
"nullable": true
},
"assetEicCode": {
"type": "string",
"nullable": true
},
"assetType": {
"type": "string",
"nullable": true
},
"affectedUnit": {
"type": "string",
"nullable": true
},
"affectedArea": {
"type": "string",
"nullable": true
},
"assetFuelType": {
"type": "string",
"nullable": true
},
"assetNormalCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"availableCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"unavailableCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"eventStartString": {
"type": "string",
"nullable": true
},
"eventEndString": {
"type": "string",
"nullable": true
},
"cause": {
"type": "string",
"nullable": true
},
"eventStatus": {
"type": "string",
"nullable": true
},
"relatedInformation": {
"type": "string",
"nullable": true
},
"activeFlag": {
"type": "string",
"nullable": true
},
"messageType": {
"type": "string",
"nullable": true
},
"unavailabilityType": {
"type": "string",
"nullable": true
},
"acerCode": {
"type": "string",
"nullable": true
},
"biddingZone": {
"type": "string",
"nullable": true
},
"outageProfile": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitOutageProfile"
},
"revisionNumber": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitDetailList": {
"type": "object",
"properties": {
"item": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitDetailItem"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitDetailMetadata": {
"type": "object",
"properties": {
"httpCode": {
"type": "integer",
"format": "int32"
},
"errorType": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"queryString": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitDetailResponse": {
"type": "object",
"properties": {
"metadata": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitDetailMetadata"
},
"body": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitDetailBody"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitListItem": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"nullable": true
},
"sequenceId": {
"type": "integer",
"format": "int32"
},
"messageHeading": {
"type": "string",
"nullable": true
},
"eventType": {
"type": "string",
"nullable": true
},
"publishDateTimeString": {
"type": "string",
"nullable": true
},
"participantMarketParticipantId": {
"type": "string",
"nullable": true
},
"assetId": {
"type": "string",
"nullable": true
},
"assetEicCode": {
"type": "string",
"nullable": true
},
"assetType": {
"type": "string",
"nullable": true
},
"affectedUnit": {
"type": "string",
"nullable": true
},
"affectedArea": {
"type": "string",
"nullable": true
},
"assetFuelType": {
"type": "string",
"nullable": true
},
"assetNormalCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"assetNormalCapacitySpecified": {
"type": "boolean",
"readOnly": true
},
"availableCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"availableCapacitySpecified": {
"type": "boolean",
"readOnly": true
},
"eventStartString": {
"type": "string",
"nullable": true
},
"eventEndString": {
"type": "string",
"nullable": true
},
"durationUncertainty": {
"type": "string",
"nullable": true
},
"cause": {
"type": "string",
"nullable": true
},
"eventStatus": {
"type": "string",
"nullable": true
},
"relatedInformation": {
"type": "string",
"nullable": true
},
"activeFlag": {
"type": "string",
"nullable": true
},
"revisionNumber": {
"type": "integer",
"format": "int32"
},
"messageType": {
"type": "string",
"nullable": true
},
"unavailabilityType": {
"type": "string",
"nullable": true
},
"unavailableCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"unavailableCapacitySpecified": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitListMetadata": {
"type": "object",
"properties": {
"httpCode": {
"type": "integer",
"format": "int32"
},
"errorType": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"cappingApplied": {
"type": "string",
"nullable": true
},
"cappingLimit": {
"type": "integer",
"format": "int32"
},
"queryString": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitListResponse": {
"type": "object",
"properties": {
"legacyRemitListMetadata": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitListMetadata"
},
"legacyRemitListResponseBody": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitListResponseBody"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitListResponseBody": {
"type": "object",
"properties": {
"dataItem": {
"type": "string",
"nullable": true
},
"legacyRemitResponseList": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitResponseList"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitOutageProfile": {
"type": "object",
"properties": {
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitOutageProfileSegment"
},
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitOutageProfileSegment": {
"type": "object",
"properties": {
"segmentStartString": {
"type": "string",
"nullable": true
},
"segmentEndString": {
"type": "string",
"nullable": true
},
"segmentCapacity": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Insights.Api.LegacyInteroperability.LegacyRemitResponseList": {
"type": "object",
"properties": {
"item": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.LegacyInteroperability.LegacyRemitListItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Data.Entities.LoadShapePeriodData": {
"type": "object",
"properties": {
"sourceFileName": {
"type": "string",
"nullable": true
},
"sourceFileDatetime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementPeriodStartDateTime": {
"type": "string",
"format": "date-time"
},
"settlementPeriodEndDateTime": {
"type": "string",
"format": "date-time"
},
"settlementPeriod": {
"type": "integer",
"format": "int32"
},
"gspGroupId": {
"type": "string",
"nullable": true
},
"connectionTypeIndicator": {
"type": "string",
"nullable": true
},
"marketSegmentIndicator": {
"type": "string",
"nullable": true
},
"domesticPremiseIndicator": {
"type": "string",
"nullable": true
},
"measurementQuantityId": {
"type": "string",
"nullable": true
},
"runNumber": {
"type": "integer",
"format": "int32"
},
"eventCode": {
"type": "string",
"nullable": true
},
"settlementPeriodDuration": {
"type": "integer",
"format": "int32"
},
"loadShapePeriodValue": {
"type": "number",
"format": "double"
},
"defaultLoadShapeFlag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Data.Entities.LoadShapeTotalsData": {
"type": "object",
"properties": {
"sourceFileName": {
"type": "string",
"nullable": true
},
"sourceFileDatetime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"gspGroupId": {
"type": "string",
"nullable": true
},
"connectionTypeIndicator": {
"type": "string",
"nullable": true
},
"marketSegmentIndicator": {
"type": "string",
"nullable": true
},
"domesticPremiseIndicator": {
"type": "string",
"nullable": true
},
"measurementQuantityId": {
"type": "string",
"nullable": true
},
"runNumber": {
"type": "integer",
"format": "int32"
},
"eventCode": {
"type": "string",
"nullable": true
},
"settlementPeriodDuration": {
"type": "integer",
"format": "int32"
},
"loadShapeDayTotal": {
"type": "number",
"format": "double"
},
"loadShapeDayPeakTotal": {
"type": "number",
"format": "double",
"nullable": true
},
"loadShapeDayOffPeakTotal": {
"type": "number",
"format": "double",
"nullable": true
},
"loadShape7DayRollingTotal": {
"type": "number",
"format": "double"
},
"loadShape7DayRollingPeakTotal": {
"type": "number",
"format": "double",
"nullable": true
},
"loadShape7DayRollingOffPeakTotal": {
"type": "number",
"format": "double",
"nullable": true
},
"loadShapeRollingAnnualTotal": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Metadata.ApiResponseSourceMetadata": {
"type": "object",
"properties": {
"datasets": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"example": [
"DATASET"
]
}
},
"additionalProperties": false
},
"Insights.Api.Models.Metadata.RemitApiResponseSourceMetadata": {
"type": "object",
"properties": {
"datasets": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"example": [
"DATASET"
]
},
"source": {
"type": "string",
"nullable": true,
"example": "Elexon"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Requests.DataStatus.RemitDataSource": {
"enum": [
"Elexon",
"MFT"
],
"type": "string"
},
"Insights.Api.Models.Responses.Balancing.BalancingServicesVolume": {
"type": "object",
"properties": {
"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"
},
"time": {
"type": "string",
"format": "date-time",
"example": "2022-07-25T09:34:00Z"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2022-06-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
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "ABRBO-1"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_ABRBO-1"
},
"acceptanceNumber": {
"type": "integer",
"format": "int32",
"example": 1234567
},
"acceptanceTime": {
"type": "string",
"format": "date-time",
"example": "2022-06-25T13:30:00Z"
},
"deemedBoFlag": {
"type": "boolean",
"example": true
},
"soFlag": {
"type": "boolean",
"example": false
},
"storFlag": {
"type": "boolean",
"example": true
},
"rrFlag": {
"type": "boolean",
"nullable": true,
"example": false
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.BidOfferResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2022-07-25"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 3
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "ABRBO-1"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_ABRBO-1"
},
"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
},
"bid": {
"type": "number",
"format": "double",
"example": 668.67
},
"offer": {
"type": "number",
"format": "double",
"example": -71.5
},
"pairId": {
"type": "integer",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse": {
"type": "object",
"properties": {
"participantId": {
"type": "string",
"nullable": true,
"example": "INVE"
},
"participantName": {
"type": "string",
"nullable": true,
"example": "AMPowerUK Ltd"
},
"creditDefaultLevel": {
"type": "integer",
"format": "int32",
"example": 2
},
"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.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.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.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.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.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.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.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.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2022-06-25"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 29
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2022-06-25T13:00:00Z"
},
"id": {
"type": "integer",
"format": "int32",
"example": 1
},
"cost": {
"type": "number",
"format": "double",
"nullable": true,
"example": 1850.9
},
"volume": {
"type": "number",
"format": "double",
"example": 5
},
"price": {
"type": "number",
"format": "double",
"nullable": true,
"example": 370.18
},
"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.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2022-09-26"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 27
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2022-09-26T13:00:00Z"
},
"buyActionCount": {
"type": "integer",
"format": "int32",
"example": 2
},
"sellActionCount": {
"type": "integer",
"format": "int32",
"example": 2
},
"buyPriceMinimum": {
"type": "number",
"format": "double",
"nullable": true,
"example": 10.23
},
"buyPriceMaximum": {
"type": "number",
"format": "double",
"nullable": true,
"example": 30.45
},
"buyPriceAverage": {
"type": "number",
"format": "double",
"nullable": true,
"example": 20.34
},
"sellPriceMinimum": {
"type": "number",
"format": "double",
"nullable": true,
"example": 1.23
},
"sellPriceMaximum": {
"type": "number",
"format": "double",
"nullable": true,
"example": 3.45
},
"sellPriceAverage": {
"type": "number",
"format": "double",
"nullable": true,
"example": 2.34
},
"buyVolumeTotal": {
"type": "number",
"format": "double",
"nullable": true,
"example": 40.68
},
"sellVolumeTotal": {
"type": "number",
"format": "double",
"nullable": true,
"example": 4.68
},
"netVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 36
}
},
"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.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.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.Balancing.Dynamic.DatasetRows.MaximumDeliveryBidData": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true,
"example": "MDB"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2026-06-10"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 3
},
"timeFrom": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T01:00:00Z"
},
"timeTo": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T01:10:00Z"
},
"levelFrom": {
"type": "number",
"format": "double",
"example": 5
},
"levelTo": {
"type": "number",
"format": "double",
"example": 46
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "HLIM03"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "AG-HLIM03"
},
"publishTime": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T02:00:00Z"
},
"serialNumber": {
"type": "string",
"nullable": true,
"example": "00002"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.MaximumDeliveryOfferData": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true,
"example": "MDO"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2026-06-10"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 3
},
"timeFrom": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T01:00:00Z"
},
"timeTo": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T01:10:00Z"
},
"levelFrom": {
"type": "number",
"format": "double",
"example": 5
},
"levelTo": {
"type": "number",
"format": "double",
"example": 46
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "HLIM03"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "AG-HLIM03"
},
"publishTime": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T02:00:00Z"
},
"serialNumber": {
"type": "string",
"nullable": true,
"example": "00002"
}
},
"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.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.Balancing.Dynamic.DynamicData": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true,
"example": "SEL"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_ABRBO-1"
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "ABRBO-1"
},
"time": {
"type": "string",
"format": "date-time",
"example": "2022-07-01T13:34:00Z"
},
"value": {
"type": "integer",
"format": "int64",
"example": 5
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2022-07-01"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 3
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Dynamic.DynamicParametersData": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true,
"example": "MDO"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2026-06-10"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 3
},
"timeFrom": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T01:00:00Z"
},
"timeTo": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T01:10:00Z"
},
"levelFrom": {
"type": "number",
"format": "double",
"example": 5
},
"levelTo": {
"type": "number",
"format": "double",
"example": 46
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "HLIM03"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "AG-HLIM03"
},
"publishTime": {
"type": "string",
"format": "date-time",
"example": "2026-06-10T02:00:00Z"
},
"serialNumber": {
"type": "string",
"nullable": true,
"example": "00002"
}
},
"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.Balancing.MarketIndexResponse": {
"type": "object",
"properties": {
"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.Balancing.NetBalancingServicesAdjustmentResponse": {
"type": "object",
"properties": {
"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
},
"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.Balancing.NonBmStorResponse": {
"type": "object",
"properties": {
"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.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.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.Balancing.Physical.PhysicalData": {
"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.Balancing.Settlement.AcceptanceVolumeResponse": {
"type": "object",
"properties": {
"createdDateTime": {
"type": "string",
"format": "date-time",
"example": "2023-02-28T15:31:12Z"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-03-01"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 2
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-03-01T00:30:00Z"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_ABRBO-1"
},
"bmUnitType": {
"type": "string",
"example": "T"
},
"leadPartyName": {
"type": "string",
"nullable": true,
"example": "Aberdeen Offshore Wind Farm"
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "ABRBO-1"
},
"acceptanceId": {
"type": "integer",
"format": "int64",
"example": 76110
},
"acceptanceDuration": {
"type": "string",
"nullable": true,
"example": "L"
},
"totalVolumeAccepted": {
"type": "number",
"format": "double",
"nullable": true,
"example": -75.725
},
"pairVolumes": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.DerivedDataBidOfferPairs"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.DerivedDataBidOfferPairs": {
"type": "object",
"properties": {
"negative1": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"positive1": {
"type": "number",
"format": "double",
"nullable": true,
"example": 23062.377
},
"negative2": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"positive2": {
"type": "number",
"format": "double",
"nullable": true,
"example": 5017.6255
},
"negative3": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"positive3": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"negative4": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"positive4": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"negative5": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"positive5": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"negative6": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"positive6": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-11-15"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 1
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "2__AFLEX003"
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "AG-AFLX03"
},
"acceptanceNumber": {
"type": "integer",
"format": "int64",
"example": 22
},
"acceptanceTime": {
"type": "string",
"format": "date-time",
"example": "2023-11-15T00:00:00Z"
},
"bidPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": -44.95
},
"offerPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": 449.95
},
"bidOfferPairId": {
"type": "integer",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-03-01"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 1
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-03-01T00:00:00Z"
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2023-09-17T09:03:18.74Z"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "2__AFLEX003"
},
"bmUnitType": {
"type": "string",
"example": "S"
},
"leadPartyName": {
"type": "string",
"nullable": true,
"example": "Flexitricity Limited"
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "AG-AFLX03"
},
"bidOfferPairCashflows": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.DerivedDataBidOfferPairs"
},
"totalCashflow": {
"type": "number",
"format": "double",
"example": 28080.002
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse": {
"type": "object",
"properties": {
"createdDateTime": {
"type": "string",
"format": "date-time",
"example": "2023-02-28T15:31:12Z"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-03-01"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 2
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-03-01T00:30:00Z"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_ABRBO-1"
},
"bmUnitType": {
"type": "string",
"example": "T"
},
"leadPartyName": {
"type": "string",
"nullable": true,
"example": "Aberdeen Offshore Wind Farm"
},
"nationalGridBmUnit": {
"type": "string",
"nullable": true,
"example": "ABRBO-1"
},
"dataType": {
"type": "string",
"nullable": true,
"example": "Original"
},
"totalVolumeAccepted": {
"type": "number",
"format": "double",
"nullable": true,
"example": -75.725
},
"pairVolumes": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.DerivedDataBidOfferPairs"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-11-15"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 1
},
"indicatedImbalance": {
"type": "integer",
"format": "int64",
"nullable": true,
"example": 419
},
"offerVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 51708.5
},
"bidVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": -60941.5
},
"totalAcceptedOfferVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 376.35834
},
"totalAcceptedBidVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": -164.875
},
"pricedAcceptedOffersVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 573.8417
},
"pricedAcceptedBidsVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": -42.375
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-09-18"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 2
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-09-18T00:30:00Z"
},
"messageReceivedDateTime": {
"type": "string",
"format": "date-time",
"example": "2023-09-17T15:31:12Z"
},
"messageSeverity": {
"type": "string",
"nullable": true,
"example": "Error"
},
"messageTypeCode": {
"type": "string",
"nullable": true,
"example": "ERR-BM-001"
},
"messageType": {
"type": "string",
"nullable": true,
"example": "FPN"
},
"messageText": {
"type": "string",
"nullable": true,
"example": "No FPN files have been received."
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2021-12-05"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 14
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2021-12-05T08:00:00Z"
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2023-09-17T09:03:18.74Z"
},
"sequenceNumber": {
"type": "integer",
"format": "int32",
"example": 1
},
"id": {
"type": "string",
"nullable": true,
"example": "T_STAY-2"
},
"acceptanceId": {
"type": "integer",
"format": "int64",
"nullable": true,
"example": 102999
},
"bidOfferPairId": {
"type": "integer",
"format": "int32",
"nullable": true,
"example": 1
},
"cadlFlag": {
"type": "boolean",
"nullable": true,
"example": false
},
"soFlag": {
"type": "boolean",
"nullable": true,
"example": false
},
"storProviderFlag": {
"type": "boolean",
"nullable": true,
"example": false
},
"repricedIndicator": {
"type": "boolean",
"example": false
},
"reserveScarcityPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"originalPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": 202
},
"volume": {
"type": "number",
"format": "double",
"example": 52.5
},
"dmatAdjustedVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 52.5
},
"arbitrageAdjustedVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 52.5
},
"nivAdjustedVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 52.5
},
"parAdjustedVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"finalPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"transmissionLossMultiplier": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0.9933898
},
"tlmAdjustedVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"tlmAdjustedCost": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryPrice": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"format": "double",
"nullable": true,
"example": -53.66
},
"volume": {
"type": "number",
"format": "double",
"nullable": true,
"example": -0.994
},
"value": {
"type": "number",
"format": "double",
"nullable": true,
"example": 54
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryResponse": {
"type": "object",
"properties": {
"createdDateTime": {
"type": "string",
"format": "date-time",
"example": "2023-03-01T00:44:58Z"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-03-01"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 1
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2023-03-01T00:00:00Z"
},
"adjuster": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"priceDerivationCode": {
"type": "string",
"nullable": true,
"example": "N"
},
"systemSellPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": 54
},
"systemBuyPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": 54
},
"mainPrice": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryPrice"
},
"marketPrice": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryPrice"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-09-18"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 2
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-09-18T00:30:00Z"
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"example": "2023-09-17T15:31:12Z"
},
"systemSellPrice": {
"type": "number",
"format": "double",
"example": 215
},
"systemBuyPrice": {
"type": "number",
"format": "double",
"example": 215
},
"bsadDefaulted": {
"type": "boolean",
"example": false
},
"priceDerivationCode": {
"type": "string",
"nullable": true,
"example": "P"
},
"reserveScarcityPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"netImbalanceVolume": {
"type": "number",
"format": "double",
"example": 291.9136
},
"sellPriceAdjustment": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"buyPriceAdjustment": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"replacementPrice": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"replacementPriceReferenceVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"totalAcceptedOfferVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 790.6547
},
"totalAcceptedBidVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": -738.74115
},
"totalAdjustmentSellVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 0
},
"totalAdjustmentBuyVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 240
},
"totalSystemTaggedAcceptedOfferVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 789.6547
},
"totalSystemTaggedAcceptedBidVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": -738.74115
},
"totalSystemTaggedAdjustmentSellVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": null
},
"totalSystemTaggedAdjustmentBuyVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 240
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DataStatus.DataStatusResponse": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2021-12-05"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 14
},
"dataPointCount": {
"type": "integer",
"format": "int32",
"example": 31
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse"
},
"nullable": true
}
},
"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.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.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.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.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.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.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.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.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.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.MaximumDeliveryBidData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.MaximumDeliveryBidData"
},
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.MaximumDeliveryOfferData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DatasetRows.MaximumDeliveryOfferData"
},
"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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.DemandForecast.DemandForecastDaily": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"transmissionSystemDemand": {
"type": "integer",
"format": "int64"
},
"nationalDemand": {
"type": "integer",
"format": "int64",
"nullable": true
},
"forecastDate": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"transmissionSystemDemand": {
"type": "integer",
"format": "int64"
},
"nationalDemand": {
"type": "integer",
"format": "int64",
"nullable": true
},
"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.DemandForecast.DemandForecastPeak": {
"type": "object",
"properties": {
"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
},
"transmissionSystemDemand": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"transmissionSystemDemand": {
"type": "integer",
"format": "int64"
},
"nationalDemand": {
"type": "integer",
"format": "int64",
"nullable": true
},
"forecastWeek": {
"type": "integer",
"format": "int32"
},
"forecastYear": {
"type": "integer",
"format": "int32"
},
"weekStartDate": {
"type": "string",
"format": "date"
}
},
"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.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.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.DemandOutturn.DemandOutturn": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementPeriod": {
"type": "integer",
"format": "int32"
},
"initialDemandOutturn": {
"type": "integer",
"format": "int64",
"nullable": true
},
"initialTransmissionSystemDemandOutturn": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementPeriod": {
"type": "integer",
"format": "int32"
},
"initialTransmissionSystemDemandOutturn": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date",
"example": "2021-10-01"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 3
},
"halfHourEndTime": {
"type": "string",
"format": "date-time",
"example": "2021-10-01T01:00:00Z"
},
"demand": {
"type": "number",
"format": "double",
"example": 36256
},
"settlementRunType": {
"type": "string",
"nullable": true,
"example": "II"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.DemandOutturn.IndodRow": {
"type": "object",
"properties": {
"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.DemandOutturn.RollingSystemDemand": {
"type": "object",
"properties": {
"recordType": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"demand": {
"type": "integer",
"format": "int64",
"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
},
"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.ForecastMargin.ForecastMarginDaily": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time"
},
"margin": {
"type": "integer",
"format": "int64",
"nullable": true
},
"forecastDate": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time"
},
"margin": {
"type": "integer",
"format": "int64",
"nullable": true
},
"week": {
"type": "integer",
"format": "int32"
},
"year": {
"type": "integer",
"format": "int32"
},
"weekStartDate": {
"type": "string",
"format": "date"
}
},
"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.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.ForecastSurplus.ForecastSurplusDaily": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time"
},
"surplus": {
"type": "integer",
"format": "int64",
"nullable": true
},
"forecastDate": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time"
},
"surplus": {
"type": "integer",
"format": "int64",
"nullable": true
},
"week": {
"type": "integer",
"format": "int32"
},
"year": {
"type": "integer",
"format": "int32"
},
"weekStartDate": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Generation.AvailabilityDaily": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true
},
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2024-06-07T15:00:00Z"
},
"fuelType": {
"type": "string",
"nullable": true,
"example": "CCGT"
},
"ngcBmUnit": {
"type": "string",
"nullable": true,
"example": "CARR-1"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_CARR-1"
},
"outputUsable": {
"type": "integer",
"format": "int64",
"nullable": true,
"example": 418
},
"forecastDate": {
"type": "string",
"format": "date",
"example": "2024-06-07"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Generation.AvailabilityWeekly": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true
},
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2024-06-07T15:00:00Z"
},
"fuelType": {
"type": "string",
"nullable": true,
"example": "CCGT"
},
"ngcBmUnit": {
"type": "string",
"nullable": true,
"example": "CARR-1"
},
"bmUnit": {
"type": "string",
"nullable": true,
"example": "T_CARR-1"
},
"outputUsable": {
"type": "integer",
"format": "int64",
"nullable": true,
"example": 418
},
"year": {
"type": "integer",
"format": "int32",
"example": 2024
},
"calendarWeekNumber": {
"type": "integer",
"format": "int32",
"example": 23
}
},
"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.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.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.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.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.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.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.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.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.Generation.GenerationByFuelType": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fuelType": {
"type": "string",
"nullable": true
},
"currentUsage": {
"type": "integer",
"format": "int64",
"nullable": true
},
"currentPercentage": {
"type": "number",
"format": "double"
},
"halfHourUsage": {
"type": "integer",
"format": "int64",
"nullable": true
},
"halfHourPercentage": {
"type": "number",
"format": "double"
},
"twentyFourHourUsage": {
"type": "integer",
"format": "int64",
"nullable": true
},
"twentyFourHourPercentage": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn": {
"type": "object",
"properties": {
"dataset": {
"type": "string",
"nullable": true,
"readOnly": true
},
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementDateTimezone": {
"type": "string",
"nullable": true,
"readOnly": true
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"interconnectorName": {
"type": "string",
"nullable": true
},
"generation": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Generation.OutturnGenerationBySettlementPeriod": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.OutturnGenerationValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Generation.OutturnGenerationValue": {
"type": "object",
"properties": {
"fuelType": {
"type": "string",
"nullable": true
},
"generation": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Generation.WindGenerationForecast": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementPeriod": {
"type": "integer",
"format": "int32"
},
"generation": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"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.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.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.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.IndicatedForecast.IndicatedForecast": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementPeriod": {
"type": "integer",
"format": "int32"
},
"boundary": {
"type": "string",
"nullable": true
},
"indicatedGeneration": {
"type": "integer",
"format": "int64",
"nullable": true
},
"indicatedDemand": {
"type": "integer",
"format": "int64",
"nullable": true
},
"indicatedMargin": {
"type": "integer",
"format": "int64",
"nullable": true
},
"indicatedImbalance": {
"type": "integer",
"format": "int64",
"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.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.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.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.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.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.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.Misc.DemandControlInstructionData": {
"type": "object",
"properties": {
"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.Misc.LossOfLoadProbabilityDeratedMarginResponse": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"example": "2023-01-31 17:36"
},
"publishingPeriodCommencingTime": {
"type": "string",
"format": "date-time",
"example": "2023-01-31 17:30"
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-01-31 18:30"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-01-31"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 38
},
"forecastHorizon": {
"type": "number",
"format": "double",
"example": 1
},
"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.Misc.SoSoPrices": {
"type": "object",
"properties": {
"contractIdentification": {
"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"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2023-01-31"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Misc.SystemFrequency": {
"type": "object",
"properties": {
"measurementTime": {
"type": "string",
"format": "date-time"
},
"frequency": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Misc.SystemWarningsData": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2022-09-20T00:00Z"
},
"warningType": {
"type": "string",
"nullable": true,
"example": "IT SYSTEMS OUTAGE"
},
"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.Misc.TemperatureData": {
"type": "object",
"properties": {
"measurementDate": {
"type": "string",
"format": "date"
},
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"temperature": {
"type": "number",
"format": "double",
"nullable": true
},
"temperatureReferenceAverage": {
"type": "number",
"format": "double",
"nullable": true
},
"temperatureReferenceHigh": {
"type": "number",
"format": "double",
"nullable": true
},
"temperatureReferenceLow": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Reference.BmUnitData": {
"type": "object",
"properties": {
"nationalGridBmUnit": {
"type": "string",
"nullable": true
},
"elexonBmUnit": {
"type": "string",
"nullable": true
},
"eic": {
"type": "string",
"nullable": true
},
"fuelType": {
"type": "string",
"nullable": true
},
"leadPartyName": {
"type": "string",
"nullable": true
},
"bmUnitType": {
"type": "string",
"nullable": true
},
"fpnFlag": {
"type": "boolean",
"nullable": true
},
"bmUnitName": {
"type": "string",
"nullable": true
},
"leadPartyId": {
"type": "string",
"nullable": true
},
"demandCapacity": {
"type": "string",
"nullable": true
},
"generationCapacity": {
"type": "string",
"nullable": true
},
"productionOrConsumptionFlag": {
"type": "string",
"nullable": true
},
"transmissionLossFactor": {
"type": "string",
"nullable": true
},
"workingDayCreditAssessmentImportCapability": {
"type": "string",
"nullable": true
},
"nonWorkingDayCreditAssessmentImportCapability": {
"type": "string",
"nullable": true
},
"workingDayCreditAssessmentExportCapability": {
"type": "string",
"nullable": true
},
"nonWorkingDayCreditAssessmentExportCapability": {
"type": "string",
"nullable": true
},
"creditQualifyingStatus": {
"type": "boolean"
},
"demandInProductionFlag": {
"type": "boolean"
},
"gspGroupId": {
"type": "string",
"nullable": true
},
"gspGroupName": {
"type": "string",
"nullable": true
},
"interconnectorId": {
"type": "string",
"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.Reference.InterconnectorData": {
"type": "object",
"properties": {
"interconnectorId": {
"type": "string",
"nullable": true
},
"interconnectorName": {
"type": "string",
"nullable": true
},
"interconnectorBiddingZone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.RemitResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.RemitApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapePeriodData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapePeriodData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Data.Entities.LoadShapeTotalsData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Data.Entities.LoadShapeTotalsData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BalancingServicesVolume": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.BalancingServicesVolume"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.BidOfferAcceptancesResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.BidOfferResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.BidOfferResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentDetailsResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.DisaggregatedBalancingServicesAdjustmentSummaryResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DynamicData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Dynamic.DynamicParametersData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Dynamic.DynamicParametersData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-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
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.MarketIndexResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.MarketIndexResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.NetBalancingServicesAdjustmentResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.NonBmStorResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.NonBmStorResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Physical.PhysicalData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Physical.PhysicalData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.HistoricAcceptanceResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.MarketDepthResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DataStatus.DataStatusResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DataStatus.DataStatusResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DemandForecastDaily"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DemandForecastDayAhead"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DemandForecastPeak"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandForecast.DemandForecastWeekly"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturn": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DemandOutturn"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.DemandOutturnPeak"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.IndicativeDemandPeak"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.IndodRow": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.IndodRow"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.DemandOutturn.RollingSystemDemand"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.ForecastMarginDaily"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ForecastMargin.ForecastMarginWeekly"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityDaily": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.AvailabilityDaily"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.AvailabilityWeekly": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.AvailabilityWeekly"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.HalfHourlyInterconnectorOutturn"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Generation.WindGenerationForecast": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Generation.WindGenerationForecast"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.IndicatedForecast.IndicatedForecast"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.DemandControlInstructionData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.DemandControlInstructionData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.LossOfLoadProbabilityDeratedMarginResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SoSoPrices": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.SoSoPrices"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemFrequency": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.SystemFrequency"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.SystemWarningsData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.SystemWarningsData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Misc.TemperatureData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Misc.TemperatureData"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-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
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationBySettlementPeriod": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.ActualGenerationBySettlementPeriod"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.ActualTotalLoadPerBiddingZone"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.DayAheadAggregatedGeneration"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.DayAheadGenerationForWindAndSolar"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.DayAheadTotalLoadPerBiddingZone"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageIdentifierWithUrl"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/Insights.Api.Models.Metadata.ApiResponseSourceMetadata"
}
},
"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.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.TotalExemptSupplyVolume.TotalExemptSupplyVolumeResponse": {
"type": "object",
"properties": {
"creationTime": {
"type": "string",
"format": "date-time",
"example": "2025-01-16T15:31:12Z"
},
"settlementDate": {
"type": "string",
"format": "date",
"example": "2025-01-16"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 5
},
"settlementRunType": {
"type": "string",
"nullable": true,
"example": "R1"
},
"totalExemptSupplyVolume": {
"type": "number",
"format": "double",
"nullable": true,
"example": 505.3
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Transparency.ActualGenerationBySettlementPeriod": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-07-12 06:30:00Z"
},
"settlementPeriod": {
"type": "integer",
"format": "int32",
"example": 16
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insights.Api.Models.Responses.Transparency.ActualGenerationValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Transparency.ActualGenerationValue": {
"type": "object",
"properties": {
"businessType": {
"type": "string",
"nullable": true,
"example": "Solar generation"
},
"psrType": {
"type": "string",
"nullable": true,
"example": "Solar"
},
"quantity": {
"type": "number",
"format": "double",
"example": 1829
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Transparency.ActualGenerationWindSolar": {
"type": "object",
"properties": {
"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.Transparency.ActualTotalLoadPerBiddingZone": {
"type": "object",
"properties": {
"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.Transparency.AgptSummaryData": {
"type": "object",
"properties": {
"psrType": {
"type": "string",
"nullable": true
},
"halfHourUsage": {
"type": "number",
"format": "double"
},
"halfHourPercentage": {
"type": "number",
"format": "double"
},
"twentyFourHourUsage": {
"type": "number",
"format": "double"
},
"twentyFourHourPercentage": {
"type": "number",
"format": "double"
}
},
"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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Transparency.DayAheadAggregatedGeneration": {
"type": "object",
"properties": {
"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.DayAheadGenerationForWindAndSolar": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"example": "2023-06-29T17:25:09Z"
},
"processType": {
"type": "string",
"nullable": true,
"example": "Intraday process"
},
"businessType": {
"type": "string",
"nullable": true,
"example": "Wind generation"
},
"psrType": {
"type": "string",
"nullable": true,
"example": "Wind Offshore"
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2023-06-29T15: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.Transparency.DayAheadTotalLoadPerBiddingZone": {
"type": "object",
"properties": {
"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.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.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.Transparency.Remit.RemitMessageIdentifierWithUrl": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": 24
},
"mrid": {
"type": "string",
"nullable": true,
"example": "11XINNOGY------2-NGET-RMT-00084421"
},
"revisionNumber": {
"type": "integer",
"format": "int32",
"example": 2
},
"createdTime": {
"type": "string",
"format": "date-time",
"example": "2023-01-31T17:39:15Z"
},
"publishTime": {
"type": "string",
"format": "date-time",
"example": "2023-01-31T17:15:31Z"
},
"url": {
"type": "string",
"nullable": true,
"example": "https://data.elexon.co.uk/bmrs/api/v1/remit/24"
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Transparency.Remit.RemitMessageWithId": {
"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
}
]
},
"id": {
"type": "integer",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"Insights.Api.Models.Responses.Transparency.WeekAheadTotalLoadPerBiddingZone": {
"type": "object",
"properties": {
"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.Service.DayAheadDemandForecastRow": {
"type": "object",
"properties": {
"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
},
"transmissionSystemDemand": {
"type": "integer",
"format": "int64"
},
"nationalDemand": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"Insights.Api.Models.Service.WindGenerationForecastRow": {
"type": "object",
"properties": {
"publishTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"settlementPeriod": {
"type": "integer",
"format": "int32"
},
"generation": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"tags": [
{
"name": "Balancing Mechanism Dynamic",
"description": "Dynamic data."
},
{
"name": "Balancing Mechanism Physical",
"description": "Physical data consists of PN, QPN, MILS, & MELS."
},
{
"name": "Balancing Services Adjustment - Disaggregated",
"description": "Adjustment actions (DISBSAD) for a given settlement period, or summarised by settlement period over a time range."
},
{
"name": "Balancing Services Adjustment - Net",
"description": "Net balancing services adjustment data (NETBSAD), provided as a time series or filtered to events."
},
{
"name": "Bid-Offer",
"description": "Bid-offer data."
},
{
"name": "Bid-Offer Acceptances",
"description": "Bid-offer acceptance data (BOALF)."
},
{
"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."
},
{
"name": "Credit Default Notice",
"description": "Credit Default Notice data."
},
{
"name": "Data Status",
"description": "The number of datapoints ingested for a dataset in a given period of time, grouped by settlement period."
},
{
"name": "Demand",
"description": "GB electricity demand, including historic."
},
{
"name": "Demand Forecast",
"description": "Current or historic demand forecasts."
},
{
"name": "Generation",
"description": "GB electricity generation output, including historic."
},
{
"name": "Generation Forecast",
"description": "Current or historic generation forecasts."
},
{
"name": "Health Check",
"description": "Provides an endpoint to check the health of the Insights API service."
},
{
"name": "Indicated Forecast",
"description": "Day-and-day-ahead indicated forecast, categorized as Indicated Generation (INDGEN), Indicated Demand (INDDEM), Imbalance (IMBALNGC) and Margin (MELNGC)."
},
{
"name": "Indicative Imbalance Settlement",
"description": "Data related to the settlement process."
},
{
"name": "Legacy"
},
{
"name": "Load Shape",
"description": "Load shape period data and load shape totals data as calculated by the Load Shaping Service"
},
{
"name": "Loss of Load Probability and De-rated Margin",
"description": "Loss of load probability and de-rated margin forecast data."
},
{
"name": "Margin Forecast",
"description": "Generating Plant Operating Margin forecast data, including historical views of data by publish time or forecast date."
},
{
"name": "Market Index",
"description": "Market Index prices filtered by time."
},
{
"name": "Non-BM STOR",
"description": "Short Term Operating Reserves (STOR) data, provided as a time series or filtered to events."
},
{
"name": "Non-BM Volumes",
"description": "Balancing services volume data, filtered by BM Unit and time range."
},
{
"name": "Reference",
"description": "Reference data which can be used to filter other API requests."
},
{
"name": "REMIT",
"description": "REMIT messages, including previous revisions."
},
{
"name": "SAA Datasets",
"description": "Datasets received from the Settlement Administration Agent (SAA)"
},
{
"name": "SO-SO Prices",
"description": "SO-SO Prices (SOSO) data, filtered by start time."
},
{
"name": "Surplus Forecast",
"description": "Generating Plant Operating Surplus forecast data, including historical views of data by publish time or forecast date."
},
{
"name": "System",
"description": "Transmission System data."
},
{
"name": "System forecast",
"description": "Transmission System forecasts"
},
{
"name": "Temperature",
"description": "Daily average & reference temperatures."
}
]
}