kmax12 / gridstatus

Extract data from ISOs and other energy grid sources

gridstatus is a Python library that provides a uniform API for accessing electricity supply, demand, and pricing data for the major Independent System Operators (ISOs) in the United States. It currently supports data from CAISO, SPP, ISONE, MISO, Ercot, NYISO, and PJM.

GridStatus.io and Hosted API

To preview some of the data this library provide access to, visit GridStatus.io.

If you are trying to use our hosted API, you might want to check out the gridstatusio library here.

To learn more about our hosted API visit: https://www.gridstatus.io/api.

Community

• Need Help? Post a GitHub issue
• Want to chat? Join our Slack
• Want to stay updated? Follow us on Twitter @grid_status
• Want to contribute? Read our Contributing Guide

Installation

gridstatus supports python 3.9+. Install with pip

python -m pip install gridstatus

Upgrade using the following command

python -m pip install --upgrade gridstatus

Environment Variables

• Some parsers require the use of environment variables
  • The EIA class
  • The ErcotAPI class
• Environment variables can be set in the following ways
  • In a .env file in the root of the project
  • In the environment where the code is run
• See .env.template for the required environment variables and how to register for them

Documentation and Examples

To learn more, visit the documentation and view example notebooks.

Get Help

We'd love to answer any usage or data access questions! Please let us know by posting a GitHub issue.