gridstatusio 0.8.0

Python Client for GridStatus.io API

GridStatus.io Hosted API

Python client for accessing the GridStatus.io Hosted API.

Installation

gridstatusio supports python 3.9+. Install with pip:

pip install gridstatusio

Upgrade using the following command

python -m pip install --upgrade gridstatusio

Getting Started

• Sign up for a Grid Status account and retrieve your API key from your settings page
• Set your API key as an environment variable: export GRIDSTATUS_API_KEY=your_api_key
• NOTE: the Grid Status API has a 1 million rows per month limit on the free plan. This limit is very easy to exceed when querying data, especially real time prices.
  • Make sure to add limit to all of your get_dataset calls to avoid quickly exceeding the limit.
• The Grid Status API has rate limits that restrict the number of requests that are allowed each second, minute and hour. If rate limits are hit the client will automatically retry the request after a delay. You can configure the maximum number of retries using the max_retries parameter when initializing the client. If you find yourself hitting rate limits, you may need to add a delay between your requests. The Grid Status Pricing Page contains more details on specific rate limits.

Check out this example notebook: Getting Started

Other Examples:

• Stacked Net Load Visualization
• CAISO April Net Load Analysis
• Resample Data to Different Frequencies

Open Source

If you prefer to use an open source library that fetches data directly from the source, you can check out the github repo. For more information on Hosted API vs Open Source API, please see this guide

Get Help

We'd love to answer any usage or data access questions! Please let us know by emailing us at [e-mail]