Skip to main content

API to access energy data

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gridstatus-0.33.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gridstatus-0.33.0-py3-none-any.whl (459.0 kB view details)

Uploaded Python 3

File details

Details for the file gridstatus-0.33.0.tar.gz.

File metadata

  • Download URL: gridstatus-0.33.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gridstatus-0.33.0.tar.gz
Algorithm Hash digest
SHA256 a05527143fa72e69b63a25f02ef4ce17393394014ff8c203f5958ad1ff9873b0
MD5 aacd3d016d6b1329b057924aa42b5386
BLAKE2b-256 847e14c36d9915ab30f54b593fa625a41999b4d55b20f071cdbbcbb8b94e2608

See more details on using hashes here.

Provenance

The following attestation bundles were made for gridstatus-0.33.0.tar.gz:

Publisher: release.yaml on gridstatus/gridstatus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gridstatus-0.33.0-py3-none-any.whl.

File metadata

  • Download URL: gridstatus-0.33.0-py3-none-any.whl
  • Upload date:
  • Size: 459.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gridstatus-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eacb4a50a5d8b29d6a9f9181b6af6697af83fc9ddd8037eac628dcf5d920f388
MD5 801ff7f74477b29f16b0c26880094683
BLAKE2b-256 d2b3adc171a70df7b7686dd18212c5a4c46bf68fe0edc56e19df54202c710880

See more details on using hashes here.

Provenance

The following attestation bundles were made for gridstatus-0.33.0-py3-none-any.whl:

Publisher: release.yaml on gridstatus/gridstatus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page