Skip to main content

API to access energy data

Project description

gridstatus logo

Code Coverage PyPI version

The gridstatus open source library is a Python library maintained by Grid Status that provides a consistent API for accessing raw electricity supply, demand, and pricing data for the major Independent System Operators (ISOs) in the United States and Canada. It currently supports data from CAISO, SPP, ISONE, MISO, ERCOT, NYISO, PJM, IESO, AESO, and the EIA.

GridStatus.io and Hosted API

This library provides minimally-processed data. If you need production-ready data, consider using our hosted API or visit GridStatus.io to see the data in a web interface.

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

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
  • See .env.template for the required environment variables
  • 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

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.36.0.tar.gz (3.2 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.36.0-py3-none-any.whl (551.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gridstatus-0.36.0.tar.gz
Algorithm Hash digest
SHA256 bcf79450eb3c671a21d121e3047388227364f3650c9863a6a02355e1873b3d2d
MD5 37949c2269ba1b3e56b120375e44b8a2
BLAKE2b-256 c9461eff7457d531f1e6c97d19a87a8118154e8382ac19af7d81a3f161d6adf1

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for gridstatus-0.36.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e415f80de0f3700ae0c54ba005493209e3ada773ea6a8942127d91a644c8d7dc
MD5 9eb14f31f2f230efa8fdded649adea37
BLAKE2b-256 2861eee5393a0f4a31fb11e7a1b6ca779bce12e9b18ac89afb0381fc1a4cbf62

See more details on using hashes here.

Provenance

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