EIA data contract | PatchOps Knowledge

Provenance

PublisherEIA

API basehttps://api.eia.gov/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (22)

getRoutes

read

List available EIA routes, optionally within a parent route.

Input schema

{
  "type": "object",
  "properties": {
    "route": {
      "type": "string",
      "examples": [
        "electricity"
      ],
      "description": "Optional parent route to inspect."
    }
  },
  "additionalProperties": true
}

getData

read

Query any EIA dataset route with filters, date bounds, and paging.

Required paramsroute

Input schema

{
  "type": "object",
  "properties": {
    "route": {
      "type": "string",
      "examples": [
        "electricity/retail-sales"
      ],
      "description": "EIA dataset route, e.g. electricity/retail-sales."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true,
      "description": "Facet filters keyed by facet id."
    },
    "frequency": {
      "type": "string",
      "description": "Frequency such as annual, monthly, quarterly, or daily."
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ],
      "description": "Inclusive start date in YYYY-MM-DD format."
    },
    "end": {
      "type": "string",
      "examples": [
        "2023-12-31"
      ],
      "description": "Inclusive end date in YYYY-MM-DD format."
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      },
      "description": "Sort descriptors."
    },
    "length": {
      "type": "number",
      "description": "Maximum rows to return."
    },
    "offset": {
      "type": "number",
      "description": "Result offset."
    }
  },
  "additionalProperties": true,
  "required": [
    "route"
  ]
}

getFacets

read

Get available filter options (facets) for a dataset

Required paramsroute

Input schema

{
  "type": "object",
  "properties": {
    "route": {
      "type": "string",
      "examples": [
        "electricity/retail-sales"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "route"
  ]
}

getFacetDetails

read

Get available values for a specific facet

Required paramsroutefacetId

Input schema

{
  "type": "object",
  "properties": {
    "route": {
      "type": "string",
      "examples": [
        "electricity/retail-sales"
      ]
    },
    "facetId": {
      "type": "string",
      "examples": [
        "stateid"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "route",
    "facetId"
  ]
}

getElectricityData

read

Query a curated EIA electricity dataset.

Required paramsdataset

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true,
      "description": "Facet filters keyed by facet id."
    },
    "frequency": {
      "type": "string",
      "description": "Optional frequency override."
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ],
      "description": "Inclusive start date in YYYY-MM-DD format."
    },
    "end": {
      "type": "string",
      "description": "Inclusive end date in YYYY-MM-DD format."
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number",
      "description": "Maximum rows to return."
    },
    "offset": {
      "type": "number"
    },
    "dataset": {
      "type": "string",
      "examples": [
        "retail-sales"
      ],
      "description": "Electricity dataset slug, e.g. retail-sales."
    },
    "route": {
      "type": "string"
    }
  },
  "additionalProperties": true,
  "required": [
    "dataset"
  ]
}

getNaturalGasData

read

Query an EIA natural-gas dataset. Price series use route1="pri" and route2="fut". RNGWHHD is Henry Hub spot price; futures contracts are RNGC1, RNGC2, RNGC3, and RNGC4.

Required paramsroute1

Entitiescommodity

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Data columns to return, usually [\"value\"]."
    },
    "facets": {
      "type": "object",
      "properties": {
        "series": {
          "type": "array",
          "items": {
            "type": "string",
            "examples": [
              "RNGWHHD",
              "RNGC1",
              "RNGC2",
              "RNGC3",
              "RNGC4"
            ]
          }
        }
      },
      "additionalProperties": true,
      "description": "Facet filters; series accepts RNGWHHD spot or RNGC1-RNGC4."
    },
    "frequency": {
      "type": "string",
      "examples": [
        "monthly"
      ],
      "description": "Frequency such as monthly, weekly, or daily."
    },
    "start": {
      "type": "string",
      "examples": [
        "2025-08"
      ],
      "description": "Inclusive start date in YYYY-MM-DD format."
    },
    "end": {
      "type": "string",
      "examples": [
        "2026-08"
      ],
      "description": "Inclusive end date in YYYY-MM-DD format."
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      },
      "description": "Sort descriptors."
    },
    "length": {
      "type": "number",
      "description": "Maximum rows to return."
    },
    "offset": {
      "type": "number",
      "description": "Result offset."
    },
    "route1": {
      "type": "string",
      "examples": [
        "pri"
      ],
      "description": "First natural-gas route segment. Use \"pri\" for the EIA price dataset that groups Henry Hub spot and futures series."
    },
    "route2": {
      "type": "string",
      "examples": [
        "fut"
      ],
      "description": "Optional second route segment. Use \"fut\" with route1=\"pri\" for the EIA table containing both RNGWHHD spot and RNGC1-RNGC4 futures series."
    }
  },
  "additionalProperties": true,
  "x-patchops-queryPresets": [
    {
      "aliases": [
        "Henry Hub",
        "Henry Hub spot",
        "RNGWHHD"
      ],
      "arguments": {
        "route1": "pri",
        "route2": "fut",
        "data": [
          "value"
        ],
        "facets": {
          "series": [
            "RNGWHHD"
          ]
        }
      }
    },
    {
      "aliases": [
        "RNGC1",
        "Henry Hub futures"
      ],
      "arguments": {
        "route1": "pri",
        "route2": "fut",
        "data": [
          "value"
        ],
        "facets": {
          "series": [
            "RNGC1"
          ]
        }
      }
    },
    {
      "aliases": [
        "RNGC2"
      ],
      "arguments": {
        "route1": "pri",
        "route2": "fut",
        "data": [
          "value"
        ],
        "facets": {
          "series": [
            "RNGC2"
          ]
        }
      }
    },
    {
      "aliases": [
        "RNGC3"
      ],
      "arguments": {
        "route1": "pri",
        "route2": "fut",
        "data": [
          "value"
        ],
        "facets": {
          "series": [
            "RNGC3"
          ]
        }
      }
    },
    {
      "aliases": [
        "RNGC4"
      ],
      "arguments": {
        "route1": "pri",
        "route2": "fut",
        "data": [
          "value"
        ],
        "facets": {
          "series": [
            "RNGC4"
          ]
        }
      }
    }
  ],
  "required": [
    "route1"
  ]
}

getCoalData

read

Convenience function for coal datasets

Required paramsdataset

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "dataset": {
      "type": "string",
      "examples": [
        "aggregate-production"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "dataset"
  ]
}

getPetroleumData

read

Query petroleum prices, production, stocks, supply, or disposition by dataset.

Required paramsdataset

Entitiescommodity

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2024-01-01"
      ]
    },
    "end": {
      "type": "string"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "dataset": {
      "type": "string",
      "examples": [
        "pri/spt"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "dataset"
  ]
}

getSTEOData

read

Get Short-Term Energy Outlook (STEO) forecast projections (EIA).

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2023-01-01"
      ]
    },
    "end": {
      "type": "string",
      "examples": [
        "2024-12-31"
      ]
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getAEOData

read

Get Annual Energy Outlook (AEO) forecast projections (EIA).

Required paramsroute1

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "route1": {
      "type": "string",
      "examples": [
        "2023"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "route1"
  ]
}

getIEOData

read

Get International Energy Outlook (IEO) forecast projections (EIA).

Required paramsroute1

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "route1": {
      "type": "string",
      "examples": [
        "2023"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "route1"
  ]
}

getSEDSData

read

Get State Energy Data System (SEDS) data

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string",
      "examples": [
        "2023-12-31"
      ]
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getTotalEnergyData

read

Get Total Energy data

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string",
      "examples": [
        "2023-12-31"
      ]
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getCO2EmissionsData

read

Get CO2 Emissions data

Required paramsdataset

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "dataset": {
      "type": "string",
      "examples": [
        "co2-emissions-aggregates"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "dataset"
  ]
}

getInternationalData

read

Get International energy data

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string",
      "examples": [
        "2023-12-31"
      ]
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getNuclearOutagesData

read

Get Nuclear Outages data

Required paramsdataset

Input schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "facets": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "frequency": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "examples": [
        "2020-01-01"
      ]
    },
    "end": {
      "type": "string"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string"
          },
          "direction": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "asc"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "desc"
                ]
              }
            ]
          }
        },
        "required": [
          "column",
          "direction"
        ],
        "additionalProperties": false
      }
    },
    "length": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "dataset": {
      "type": "string",
      "examples": [
        "us-nuclear-outages"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "dataset"
  ]
}

searchGenerators

read

Form 860 generator-level capacity search with state/fuel/BA/status filters.

Input schema

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "examples": [
        "TX"
      ],
      "description": "Two-letter state code, e.g. TX."
    },
    "fuelType": {
      "type": "string",
      "examples": [
        "NG"
      ],
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Energy source code (NG, COL, NUC, WND, SUN, ...) or array."
    },
    "primeMover": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Prime mover code (CT, ST, GT, IC, ...) or array."
    },
    "balancingAuthority": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Balancing authority code (ERCO, CISO, MISO, PJM, ...) or array."
    },
    "status": {
      "type": "string",
      "description": "Operating status: OP (default), SB, OS, OA. Empty string disables filter."
    },
    "sector": {
      "type": "string",
      "description": "Sector slug (electric-utility, industrial-chp, ...)."
    },
    "minCapacityMw": {
      "type": "number",
      "examples": [
        100
      ],
      "description": "Filter to generators with nameplate capacity >= this value."
    },
    "start": {
      "type": "string",
      "examples": [
        "2024-01"
      ],
      "description": "Inclusive start month YYYY-MM."
    },
    "end": {
      "type": "string",
      "examples": [
        "2024-01"
      ],
      "description": "Inclusive end month YYYY-MM."
    },
    "length": {
      "type": "number",
      "description": "Page size (max 5000)."
    },
    "offset": {
      "type": "number",
      "description": "Page offset."
    }
  },
  "additionalProperties": true
}

getPlantGeneration

read

Form 923 monthly net generation and fuel use for a single plant.

Required paramsplantIdstartend

Input schema

{
  "type": "object",
  "properties": {
    "plantId": {
      "type": "integer",
      "examples": [
        9
      ],
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "description": "Plant ID (EIA plant code)."
    },
    "start": {
      "type": "string",
      "examples": [
        "2024-01"
      ],
      "description": "Start month YYYY-MM."
    },
    "end": {
      "type": "string",
      "examples": [
        "2024-12"
      ],
      "description": "End month YYYY-MM."
    },
    "fuelType": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Optional fuel filter (NG, COL, ALL, ...) or array."
    },
    "primeMover": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Optional prime mover filter (ST, CT, ALL, ...) or array."
    },
    "frequency": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "monthly"
          ]
        },
        {
          "type": "string",
          "enum": [
            "quarterly"
          ]
        },
        {
          "type": "string",
          "enum": [
            "annual"
          ]
        }
      ],
      "type": "string",
      "enum": [
        "monthly",
        "quarterly",
        "annual"
      ],
      "description": "Default monthly."
    },
    "length": {
      "type": "number",
      "description": "Page size (max 5000)."
    },
    "offset": {
      "type": "number",
      "description": "Page offset."
    }
  },
  "additionalProperties": true,
  "required": [
    "plantId",
    "start",
    "end"
  ]
}

searchPlants

read

One row per plant from Form 860 generators, sorted by total nameplate MW.

Input schema

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "examples": [
        "TX"
      ]
    },
    "balancingAuthority": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "fuelType": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "status": {
      "type": "string"
    },
    "sector": {
      "type": "string"
    },
    "limit": {
      "type": "number",
      "examples": [
        20
      ],
      "description": "Max plants to return (default 50)."
    },
    "start": {
      "type": "string",
      "description": "Snapshot month YYYY-MM."
    },
    "end": {
      "type": "string",
      "description": "Snapshot end month YYYY-MM."
    }
  },
  "additionalProperties": true
}

getRetirementSchedule

read

Generators with planned-retirement-year-month set, sorted ascending.

Input schema

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "examples": [
        "TX"
      ]
    },
    "fuelType": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "year": {
      "type": "number",
      "examples": [
        2030
      ],
      "description": "Filter to retirement YYYY."
    },
    "start": {
      "type": "string",
      "description": "Snapshot start month YYYY-MM."
    },
    "end": {
      "type": "string",
      "description": "Snapshot end month YYYY-MM."
    },
    "length": {
      "type": "number",
      "description": "Page size (max 5000)."
    },
    "offset": {
      "type": "number",
      "description": "Page offset."
    }
  },
  "additionalProperties": true
}

getFuelMix

read

EIA electricity generation fuel mix by fuel type (Form 923), state or national.

Required paramstime

Input schema

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "examples": [
        "TX"
      ]
    },
    "balancingAuthority": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "time": {
      "type": "string",
      "examples": [
        "2024-03"
      ],
      "description": "Period in YYYY-MM (or YYYY for annual)."
    },
    "frequency": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "monthly"
          ]
        },
        {
          "type": "string",
          "enum": [
            "quarterly"
          ]
        },
        {
          "type": "string",
          "enum": [
            "annual"
          ]
        }
      ],
      "type": "string",
      "enum": [
        "monthly",
        "quarterly",
        "annual"
      ]
    },
    "length": {
      "type": "number"
    }
  },
  "additionalProperties": true,
  "required": [
    "time"
  ]
}

getServiceInfo
read
Form 860/923 routes, facets, enum values, date format, and pagination cap.
Entitiesmetadata
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

EIA

Provenance

Freshness & coverage

Methods (22)

getRoutes

getData

getFacets

getFacetDetails

getElectricityData

getNaturalGasData

getCoalData

getPetroleumData

getSTEOData

getAEOData

getIEOData

getSEDSData

getTotalEnergyData

getCO2EmissionsData

getInternationalData

getNuclearOutagesData

searchGenerators

getPlantGeneration

searchPlants

getRetirementSchedule

getFuelMix

getServiceInfo