Elexon Insights data contract | PatchOps Knowledge

Provenance

PublisherElexon Insights

API basehttps://data.elexon.co.uk/bmrs/api/v1

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationNo credentials required

Methods (3)

getDatasets

read

List Elexon BMRS datasets.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "dataset": {
      "type": "string"
    },
    "stream": {
      "type": "boolean"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

queryBmrs

read

Query a BMRS dataset by code and params.

Required paramsdataset or endpoint

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "dataset": {
      "type": "string"
    },
    "stream": {
      "type": "boolean"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "method": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "POST"
          ]
        },
        {
          "type": "string",
          "enum": [
            "GET"
          ]
        }
      ]
    },
    "body": {}
  },
  "additionalProperties": false,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "dataset"
          ]
        },
        {
          "required": [
            "endpoint"
          ]
        }
      ]
    }
  ]
}

getSystemPrices

read

Get GB system buy/sell imbalance prices (Elexon).

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "settlementDate": {
      "type": "string"
    },
    "settlementPeriod": {
      "type": "number"
    },
    "format": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "csv"
          ]
        },
        {
          "type": "string",
          "enum": [
            "xml"
          ]
        },
        {
          "type": "string",
          "enum": [
            "json"
          ]
        }
      ]
    }
  },
  "additionalProperties": false
}