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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file gridstatusio-0.1.0.tar.gz.

File metadata

  • Download URL: gridstatusio-0.1.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for gridstatusio-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7c77bcff32186905d55b104fd20e9b61d9d33e623d2fe542d70d696a435068c8
MD5 25b7bcdbf52505aba20e050948a83235
BLAKE2b-256 23b91611a305c5bb9e41563f2ef134339a17fc56162aa86a346ad35d9f39717e

See more details on using hashes here.

File details

Details for the file gridstatusio-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gridstatusio-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e65af91db1b5beaf9d8a950b11a4319fb2fd824aa00aebdba7e97ee69823329
MD5 8701083dc1154f6a65f44105a780d631
BLAKE2b-256 e244c1e3a6a8742d9e6b16fed7579af70653d85510fb1b3676b2b8e6bda93b7a

See more details on using hashes here.

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