Electricity Maps data contract | PatchOps Knowledge

Provenance

PublisherElectricity Maps

API basehttps://api.electricitymap.org/v3

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (3)

getPowerBreakdown

read

Get power-generation breakdown by source for a zone.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "zone": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

getCarbonIntensity

read

Get carbon intensity (gCO2/kWh) for a zone.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "zone": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

getLatestZoneData

read

Get latest combined zone data (intensity + breakdown).

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "zone": {
      "type": "string"
    },
    "metric": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "zones"
          ]
        },
        {
          "type": "string",
          "enum": [
            "power-breakdown"
          ]
        },
        {
          "type": "string",
          "enum": [
            "carbon-intensity"
          ]
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}