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.32.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.32.0-py3-none-any.whl (456.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gridstatus-0.32.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.32.0.tar.gz
Algorithm Hash digest
SHA256 0d29d4c11e25bbd81f393ae3dc21d461d0f2867fbe35297f6f495eb09eb6d4df
MD5 b9805d710f681ae40c14e9b608c85173
BLAKE2b-256 f1905e22e806eb38b5fcd326e4290b16430bd603c82795c2b7682c5494229d3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for gridstatus-0.32.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.32.0-py3-none-any.whl.

File metadata

  • Download URL: gridstatus-0.32.0-py3-none-any.whl
  • Upload date:
  • Size: 456.4 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.32.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4509e3b96dc4a69cd4324ef068e6993ed22f94ba8ab02f8966ed68c453fc7c97
MD5 95699e7d60eff4ac8791bf88eda6d616
BLAKE2b-256 f9ca08f280b25a0388febbcc4de95e6aeae4e7c5a93e44f869dd74dedcc5b519

See more details on using hashes here.

Provenance

The following attestation bundles were made for gridstatus-0.32.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