{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/carbon-intensity/main/json-schema/regional-intensity.json",
  "title": "Regional Intensity",
  "description": "Carbon intensity and generation mix data for a DNO (Distribution Network Operator) region in Great Britain",
  "type": "object",
  "properties": {
    "regionid": {
      "type": "integer",
      "description": "DNO region identifier (1-17, where 15=England, 16=Scotland, 17=Wales)",
      "minimum": 1,
      "maximum": 17,
      "example": 3
    },
    "dnoregion": {
      "type": "string",
      "description": "Full name of the DNO (Distribution Network Operator) region",
      "example": "Electricity North West"
    },
    "shortname": {
      "type": "string",
      "description": "Short display name for the region",
      "example": "North West England"
    },
    "postcode": {
      "type": "string",
      "description": "Postcode queried (only present for postcode-based queries)",
      "example": "RG10"
    },
    "intensity": {
      "type": "object",
      "description": "Carbon intensity forecast for this region",
      "properties": {
        "forecast": {
          "type": "integer",
          "description": "Forecasted carbon intensity in gCO2/kWh",
          "minimum": 0,
          "example": 266
        },
        "index": {
          "type": "string",
          "description": "Qualitative carbon intensity index",
          "enum": ["very low", "low", "moderate", "high", "very high"],
          "example": "moderate"
        }
      },
      "required": ["forecast", "index"]
    },
    "generationmix": {
      "type": "array",
      "description": "Generation mix for this region",
      "items": {
        "type": "object",
        "properties": {
          "fuel": {
            "type": "string",
            "description": "Fuel type identifier",
            "enum": ["biomass", "coal", "imports", "gas", "nuclear", "other", "hydro", "solar", "wind"]
          },
          "perc": {
            "type": "number",
            "format": "float",
            "description": "Percentage of total generation from this fuel type",
            "minimum": 0,
            "maximum": 100
          }
        },
        "required": ["fuel", "perc"]
      }
    },
    "data": {
      "type": "array",
      "description": "Time-series intensity and generation mix data (present when querying by regionid or postcode with time range)",
      "items": {
        "type": "object",
        "properties": {
          "from": {
            "type": "string",
            "format": "date-time",
            "description": "Start of the half-hour period"
          },
          "to": {
            "type": "string",
            "format": "date-time",
            "description": "End of the half-hour period"
          },
          "intensity": {
            "type": "object",
            "properties": {
              "forecast": {
                "type": "integer",
                "description": "Forecasted carbon intensity in gCO2/kWh"
              },
              "index": {
                "type": "string",
                "enum": ["very low", "low", "moderate", "high", "very high"]
              }
            }
          },
          "generationmix": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fuel": {"type": "string"},
                "perc": {"type": "number"}
              }
            }
          }
        }
      }
    }
  }
}