Data

Tools

Indexes

Applications

Experiments

Open Source Science

gridstatus

Extract data from ISOs and other energy grid sources

https://github.com/gridstatus/gridstatus

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 32 committers (6.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

co2-emissions decarbonization electrical-grid energy python

Keywords from Contributors

interactive graph-library mesh interpretability profiles sequences generic projection standardization optim
Last synced: 6 months ago · JSON representation ·

Repository

Extract data from ISOs and other energy grid sources

Basic Info
Statistics
  • Stars: 354
  • Watchers: 11
  • Forks: 67
  • Open Issues: 48
  • Releases: 33
Topics
co2-emissions decarbonization electrical-grid energy python
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

gridstatus logo

Code Coverage PyPI version

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.

Owner

  • Name: gridstatus
  • Login: gridstatus
  • Kind: organization

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: max@gridstatus.io
    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.31.0
date-released: 2025-08-12

GitHub Events

Total
  • Create event: 179
  • Release event: 4
  • Issues event: 25
  • Watch event: 62
  • Delete event: 148
  • Issue comment event: 171
  • Push event: 955
  • Pull request review comment event: 543
  • Pull request review event: 676
  • Pull request event: 328
  • Fork event: 18
Last Year
  • Create event: 179
  • Release event: 4
  • Issues event: 25
  • Watch event: 62
  • Delete event: 149
  • Issue comment event: 171
  • Push event: 956
  • Pull request review comment event: 543
  • Pull request review event: 676
  • Pull request event: 329
  • Fork event: 18

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 626
  • Total Committers: 32
  • Avg Commits per committer: 19.563
  • Development Distribution Score (DDS): 0.564
Past Year
  • Commits: 224
  • Committers: 14
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.509
Top Committers
Name Email Commits
Max Kanter k****2@g****m 273
Will Koehrsen w****n@g****m 178
Ryan Kladar r****n@g****o 80
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
Brian Strauch b****n@b****m 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
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
NoahV-SC 1****C 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
and 2 more...
Committer Domains (Top 20 + Academic)
gridstatus.io: 2 usu.edu: 1 vel9.com: 1 sbcglobal.net: 1 brianstrauch.com: 1 cornell.edu: 1 apache.org: 1 advmicrogrid.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 21
  • Total pull requests: 400
  • Average time to close issues: 5 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 15
  • Total pull request authors: 14
  • Average comments per issue: 1.48
  • Average comments per pull request: 0.84
  • Merged pull requests: 329
  • Bot issues: 1
  • Bot pull requests: 23
Past Year
  • Issues: 15
  • Pull requests: 385
  • Average time to close issues: 11 days
  • Average time to close pull requests: 2 days
  • Issue authors: 11
  • Pull request authors: 11
  • Average comments per issue: 1.07
  • Average comments per pull request: 0.84
  • Merged pull requests: 317
  • Bot issues: 1
  • Bot pull requests: 23
View more stats
Top Authors
Issue Authors
  • WillKoehrsen (4)
  • iamanonym0us (4)
  • ChillarAnand (1)
  • PeterQuinn925 (1)
  • tamird (1)
  • EwanPritchard (1)
  • tichmangono (1)
  • xmattyshea (1)
  • pjrulez (1)
  • kmax12 (1)
  • jikaczmarski (1)
  • NoahV-SC (1)
  • dependabot[bot] (1)
  • Kladar (1)
  • Wolsen21 (1)
Pull Request Authors
  • WillKoehrsen (204)
  • Kladar (140)
  • dependabot[bot] (23)
  • kmax12 (10)
  • brianstrauch (8)
  • tichmangono (2)
  • tylernisonoff (2)
  • thehomebrewnerd (2)
  • keelerh (2)
  • bendnorman (2)
  • BrianWeiHaoMa (2)
  • NoahV-SC (1)
  • cwaldoch (1)
  • matthewkennedy5 (1)
Top Labels
Issue Labels
dependencies (1) bug (1)
Pull Request Labels
enhancement (83) bug (27) dependencies (23)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 38,092 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 22
  • Total maintainers: 1
pypi.org: gridstatus

API to access energy data

  • Documentation: https://gridstatus.readthedocs.io/
  • License: 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.31.0
    published 6 months ago
  • Versions: 22
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 38,092 Last month
Rankings
Downloads: 3.9%
Dependent packages count: 4.8%
Stargazers count: 4.8%
Forks count: 7.7%
Average: 8.5%
Dependent repos count: 21.5%
Maintainers (1)
kmax12
Last synced: 6 months ago

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