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 and Canada. 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.34.0.tar.gz (3.1 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.34.0-py3-none-any.whl (500.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gridstatus-0.34.0.tar.gz
Algorithm Hash digest
SHA256 f239bf79689928ec712f80d76c66cf9667d51b51657565d5f60b582d8bc295f9
MD5 ab370665040d7fcf7634753d54d456c4
BLAKE2b-256 6515ea61a5596c69c1e78229f27899772d206b9bdac4362d7e9aafe5befb8604

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: gridstatus-0.34.0-py3-none-any.whl
  • Upload date:
  • Size: 500.2 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.34.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9b9b6edea932c856e4b402770e1ec0a5a59e2587fe578c12704fdb9c15782ed
MD5 05bcf29ad7be94dbc1862bd60d2eda46
BLAKE2b-256 38449699d3e8fd92a11d19c79b5dde14f7993b671acf021e946fa0c27907ef1a

See more details on using hashes here.

Provenance

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