Skip to main content

Python Client for GridStatus.io API

Project description

GridStatus.io Hosted API

Python client for accessing the GridStatusIO API.

Installation

Install the library using pip:

pip install gridstatusio

Usage

Set API Key

To use the library, first set your API key:

import gridstatusio as gs

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

if you don't have an API, request one here.

List available datasets

gs.list_datasets()

Get specific date

Request a dataset at a specific date

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

Get data range

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

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

gridstatusio-0.1.0.tar.gz (4.6 kB view hashes)

Uploaded Source

Built Distribution

gridstatusio-0.1.0-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page