A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

gridstatus

Provides standardized API to access energy data from the major Independent System Operators in the United States.
https://github.com/gridstatus/gridstatus

Category: Energy Systems
Sub Category: Energy Data Accessibility and Integration

Keywords

co2-emissions decarbonization electrical-grid energy python

Keywords from Contributors

archiving measur transforms projection animals generic observation conversion optimize compose

Last synced: about 18 hours ago
JSON representation

Repository metadata

Extract data from ISOs and other energy grid sources

README.md

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, PJM, IESO, and the EIA.

GridStatus.io and Hosted API

To preview some of the data this library provides 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

Installation

gridstatus supports python 3.11+. Install with uv

uv pip install gridstatus

Upgrade using the following command

uv 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.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: gridstatus
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Max
    family-names: Kanter
    email: [email protected]
    affiliation: Grid Status
repository-code: 'https://github.com/gridstatus/gridstatus'
url: 'https://opensource.gridstatus.io/en/latest/'
abstract: >-
  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.
keywords:
  - energy
  - electricity
  - grid
  - python
  - data
license: BSD-3-Clause
version: 0.30.1
date-released: 2025-04-22

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 555
Total Committers: 31
Avg Commits per committer: 17.903
Development Distribution Score (DDS): 0.51

Commits in past year: 194
Committers in past year: 15
Avg Commits per committer in past year: 12.933
Development Distribution Score (DDS) in past year: 0.428

Name Email Commits
Max Kanter k****2@g****m 272
Will Koehrsen w****n@g****m 150
Ryan Kladar r****n@g****o 42
Gaurav Sheni g****i@g****m 21
Kladar r****r@a****m 14
Nate Parsons n****e@g****o 12
Jerry Chen j****y@a****g 11
Bennett Norman b****9@c****u 4
Matthew Shea s****8@g****m 3
Max Epstein m****8@g****m 3
Colin Bowen 5****n 2
Connor Waldoch c****7@g****m 2
BrianWeiHaoMa 1****a 1
Dan Morris d****s@g****m 1
DavidRothblum d****m@g****m 1
Blake Ellingham b****m@g****m 1
Brian Strauch b****4@g****m 1
dependabot[bot] 4****] 1
buckfeng b****g@g****m 1
Zach Tzavelis t****z@g****m 1
Tyler Nisonoff t****f@g****m 1
Sam Dotson 4****n 1
Michael Fore M****e@s****t 1
Matthew Kennedy m****4@g****m 1
Levan Iordanishvili l****n@v****m 1
Kyle Baranko K****O@G****M 1
Keeley Erhardt k****t@g****m 1
Jesse Kaczmarski 3****i 1
Jackson Morgan j****n@u****u 1
Hayden Cardwell 2****l 1
and 1 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 60
Total pull requests: 315
Average time to close issues: 3 months
Average time to close pull requests: 8 days
Total issue authors: 20
Total pull request authors: 22
Average comments per issue: 1.92
Average comments per pull request: 1.0
Merged pull request: 276
Bot issues: 0
Bot pull requests: 17

Past year issues: 14
Past year pull requests: 208
Past year average time to close issues: 12 days
Past year average time to close pull requests: 3 days
Past year issue authors: 10
Past year pull request authors: 14
Past year average comments per issue: 2.93
Past year average comments per pull request: 0.95
Past year merged pull request: 178
Past year bot issues: 0
Past year bot pull requests: 17

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/gridstatus/gridstatus

Top Issue Authors

  • kmax12 (29)
  • iamanonym0us (5)
  • m4rz910 (4)
  • WillKoehrsen (4)
  • jikaczmarski (2)
  • buckfeng (2)
  • pjrulez (1)
  • leoniewgnr (1)
  • arao53 (1)
  • Sparhiz (1)
  • jcsalterego (1)
  • EwanPritchard (1)
  • adam-a-a (1)
  • tamird (1)
  • PeterQuinn925 (1)

Top Pull Request Authors

  • WillKoehrsen (143)
  • kmax12 (66)
  • Kladar (54)
  • dependabot[bot] (17)
  • gsheni (8)
  • thehomebrewnerd (6)
  • jcsalterego (3)
  • kbaranko (2)
  • cwaldoch (2)
  • bendnorman (2)
  • samgdotson (1)
  • BrianWeiHaoMa (1)
  • jleonard8812 (1)
  • DavidRothblum (1)
  • brianstrauch (1)

Top Issue Labels

  • documentation (5)
  • question (1)

Top Pull Request Labels

  • enhancement (32)
  • dependencies (17)
  • bug (10)

Package metadata

pypi.org: gridstatus

API to access energy data

  • Homepage:
  • Documentation: https://gridstatus.readthedocs.io/
  • Licenses: Copyright 2022 James Max Kanter Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 0.30.1 (published 4 days ago)
  • Last Synced: 2025-04-25T07:30:40.161Z (2 days ago)
  • Versions: 21
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 19,259 Last month
  • Rankings:
    • Downloads: 3.929%
    • Dependent packages count: 4.787%
    • Stargazers count: 4.804%
    • Forks count: 7.663%
    • Average: 8.546%
    • Dependent repos count: 21.545%
  • Maintainers (1)

Dependencies

.github/workflows/docs.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/install.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/lint.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/release.yaml actions
  • FeatureLabs/gh-action-pypi-upload v2 composite
  • actions/checkout v3 composite
.github/workflows/tests.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • beautifulsoup4 >= 4.8.13
  • lxml >= 4.9.1
  • openpyxl >= 3.1.0
  • pandas >= 1.3.0
  • plotly >= 5.11.0
  • requests >= 2.28.1
  • tabula-py >= 2.5.1
  • tabulate >= 0.8.10
  • termcolor >= 2.2.0
  • tqdm >= 4.64.1

Score: 19.240047979326388