---
title: Grid Status
file_format: mystnb
mystnb:
  execution_timeout: 600
kernelspec:
  name: python3
---


# What is the gridstatus library?


<p align="center">
    <img width=75% src="https://github.com/gridstatus/gridstatus/raw/main/gridstatus-header.png" alt="gridstatus logo" />
</p>

<p align="center">
    <a href="https://github.com/gridstatus/gridstatus/actions?query=branch%3Amain+workflow%3ATests" target="_blank">
        <img src="https://github.com/gridstatus/gridstatus/workflows/Tests/badge.svg?branch=main" alt="Tests" />
    </a>
    <a href="https://codecov.io/gh/gridstatus/gridstatus" target="_blank">
        <img src="https://codecov.io/gh/gridstatus/gridstatus/branch/main/graph/badge.svg" alt="Code Coverage"/>
    </a>
    <a href="https://badge.fury.io/py/gridstatus" target="_blank">
        <img src="https://badge.fury.io/py/gridstatus.svg?maxAge=2592000" alt="PyPI Version" />
    </a>
</p>

The `gridstatus` open-source library is a Python library maintained by [Grid Status](https://www.gridstatus.io/) 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](https://www.gridstatus.io/api) or visit [GridStatus.io](https://www.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](https://github.com/gridstatus/gridstatusio).

## 5 Minute Overview

First, we can see all of the ISOs that are supported

```{code-cell}
import gridstatus
gridstatus.list_isos()
```

Next, we can select an ISO we want to use

```{code-cell}
caiso = gridstatus.CAISO()
```

### Fuel Mix

ISOs share a common API with methods like `get_fuel_mix` and `get_load`. Here is how we can get the fuel mix

```{code-cell}
caiso.get_fuel_mix("today")
```

### Load

or the energy demand throughout the current day as a Pandas DataFrame

```{code-cell}
caiso.get_load("today")
```

### Load Forecast

Another dataset we can query is the load forecast

```{code-cell}
nyiso = gridstatus.NYISO()
nyiso.get_load_forecast("today")
```

### Historical Data

You can use the historical method calls to get data for a specific day in the past. For example,

```{code-cell}
caiso.get_load("Jan 1, 2020")
```

Frequently, we want to get data across multiple days. We can do that by providing a `start` and `end` parameter to any `iso.get_*` method

```{code-cell}
:tags: [remove-stdout,remove-stderr]
caiso_load = caiso.get_load(start="Jan 1, 2021", end="Feb 1, 2021")
caiso_load
```

We can now see there is data for all of January 2021

```{code-cell}
:tags: [remove-stdout,remove-stderr]

import plotly.express as px

fig = px.line(caiso_load, x="Time", y="Load", title="CAISO Load - Jan '21")
fig
```

### Next Steps

The best part is these APIs work in the same way across all the supported ISOs!

```{toctree}
:maxdepth: 2
:caption: Getting Started

installation
lmp
interconnection_queues
```

```{toctree}
:maxdepth: 0
:caption: Examples

Examples/caiso/index.md
Examples/eia/index.md
Examples/ercot/index.md
Examples/ercot_api/index.md
Examples/nyiso/index.md
Examples/pjm/index.md
Examples/spp/index.md
Examples/ieso/index.md
Examples/misc/index.md
```


```{toctree}
:caption: Reference
:maxdepth: 1

api-reference
changelog
contributing
```