Metadata-Version: 2.1
Name: gridstatusio
Version: 0.1.0
Summary: Python Client for GridStatus.io API
Author-email: Max Kanter <kmax12@gmail.com>
Maintainer-email: Max Kanter <kmax12@gmail.com>
License: Copyright 2022 James Max Kanter
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Source Code, https://github.com/kmax12/gridstatusio/
Project-URL: Issue Tracker, https://github.com/kmax12/gridstatusio/issues
Keywords: energy,independent system operator
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: <4,>=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
License-File: LICENSE

# GridStatus.io Hosted API

Python client for accessing the [GridStatusIO API](https://www.gridstatus.io/api).

## Installation

Install the library using pip:

```bash
pip install gridstatusio
```


## Usage

### Set API Key
To use the library, first set your API key:

```python
import gridstatusio as gs

gs.api_key  = '<YOUR-API-KEY>'
```

if you don't have an API, request one [here](https://www.gridstatus.io/api). 

### List available datasets

```python
gs.list_datasets()
```

### Get specific date

Request a dataset at a specific date

```python
gs.get_dataset(
    dataset="isone/fuel_mix_clean",
    date="2023-01-01",
)
```

### Get data range

```python
df = gs.get_dataset(
    dataset="isone/fuel_mix_clean",
    start="2023-01-01",
    end="2023-01-05",
    verbose=True,
)
```

## Get Help

We'd love to answer any usage or data access questions! Please let us know by emailing us at contact@gridstatus.io
