- Adds a
timezoneparameter used for returning results in local time and resampling results to frequencies one day or lower- With this addition, the
tzparameter is deprecated and will be removed in a future release - When using the
timezoneparameter, the_localcolumns will be in the timezone and_utccolumns will be in UTC
- With this addition, the
With tz (deprecated):
client.get_dataset(
dataset='ercot_load',
start=start,
end=end,
tz='America/New_York'
)| interval_start_local | interval_end_local | load | |
|---|---|---|---|
| 0 | 2025-01-01 00:00:00-05:00 | 2025-01-01 00:05:00-05:00 | 44859 |
| 1 | 2025-01-01 00:05:00-05:00 | 2025-01-01 00:10:00-05:00 | 44993 |
| 2 | 2025-01-01 00:10:00-05:00 | 2025-01-01 00:15:00-05:00 | 44894 |
| 3 | 2025-01-01 00:15:00-05:00 | 2025-01-01 00:20:00-05:00 | 44863 |
| 4 | 2025-01-01 00:20:00-05:00 | 2025-01-01 00:25:00-05:00 | 44845 |
With timezone:
client.get_dataset(
dataset='ercot_load',
start=start,
end=end,
timezone='America/New_York'
)| interval_start_local | interval_start_utc | interval_end_local | interval_end_utc | load | |
|---|---|---|---|---|---|
| 0 | 2025-01-01 00:00:00-05:00 | 2025-01-01 05:00:00+00:00 | 2025-01-01 00:05:00-05:00 | 2025-01-01 05:05:00+00:00 | 44859 |
| 1 | 2025-01-01 00:05:00-05:00 | 2025-01-01 05:05:00+00:00 | 2025-01-01 00:10:00-05:00 | 2025-01-01 05:10:00+00:00 | 44993 |
| 2 | 2025-01-01 00:10:00-05:00 | 2025-01-01 05:10:00+00:00 | 2025-01-01 00:15:00-05:00 | 2025-01-01 05:15:00+00:00 | 44894 |
| 3 | 2025-01-01 00:15:00-05:00 | 2025-01-01 05:15:00+00:00 | 2025-01-01 00:20:00-05:00 | 2025-01-01 05:20:00+00:00 | 44863 |
| 4 | 2025-01-01 00:20:00-05:00 | 2025-01-01 05:20:00+00:00 | 2025-01-01 00:25:00-05:00 | 2025-01-01 05:25:00+00:00 | 44845 |
- Adds automatic retries using an exponential backoff when fetching data if an API rate limit is hit. Also adds parameters for configuring
max_retriesonGridStatusClientand an optionalsleep_timeparameter onGridStatusClient.get_dataset.
- Updates for resampling changes on server. Upsampling is now supported.
- Remove
gridstatusand addtabulateas dependencies.
- Updates pandas version to allow for pandas 2.0 compatibility
- Adds a new
client.get_daily_peak_report()method for accessing daily peak LMP/load data for a specific ISO and date.
- Sets capped version of Python to <4
- Upgrades numpy to a version that supports Python 3.12
- Adds support for Python 3.12
- Add ability to use cursor-based pagination instead of offset-based pagination.
- Cursor-based pagination can be 30-50% faster than offset-based pagination for large datasets.
- Cursor-based pagination is the default for
client.get_dataset().
- Drops support for Python 3.8
- Fix warning to upgrade when already on latest version
- [Does not affect usage]. Switch to
poetryfor package management
- Fix bug where
GridStatusClient.list_datasetswould error whenreturn_list=False
- Rename
max_rowstopage_size
- Add support for querying based on
publish_timetoclient.get_dataset
- Add
resample_byandresample_functionparameters to further specify resampling behavior. Example notebook: Resample Data to Different Frequencies
- Support data resampling with
resampleparameter
- Fix date parsing in cases where there is no data or all missing values
- Checks for an updated version of gridstatusio library at import and alerts user if a newer version is available.
- Add stacked net load visualization example notebook
- When using
client.get_dataset(), the number of rows per request now defaults to maximum allowed by your API key. You can specify a lower limit using thelimitparameter. We recommend using the default for maximum performance.
- Fix date parsing in older versions of pandas
- Improve dataset download times by switching to json return format from API
- Fix mixed dtype warning
- Revised the functionality of the verbose flag. Now, when it's set to False, no output is generated. If set to True or "info", it provides a moderate level of information. For the most detailed output, set it to "debug".
- Specifiy a filter operator when using filtering. Supports "=", "!=", ">", "<", ">=", "<=", "in".
- Specify subset of columns to query
- Fix parsing of Forecast Time column in forecast datasets
- Fix duplicated dataframe index when querying across multiple pages