Skip to main content

Python Client for the IsoStream API

Project description

isostream

ISOStream API

A simple wrapper around the ISOStream API that produces JSON or well formated pandas DataFrames from query results. The the API client, methods, inputs and responses and all dynamically created from the OpenAPI specification of the IsoStream REST API.

Installation

You can install the library with: pip install isostream

Quickstart

The ISOStream client is dynamically generated from the OpenAPI specification from the ISOStream API. See the ISOStream API Documentation for more details. All of the REST API endpoints available on client as methods.

`` from isostream import IsoStream

client = IsoStream("<your_api_key_>")

df = client.dalmp_node(node="WESTERN HUB", start="2021-01-01", end="2021-02-01", iso="PJM") ``

All string timestamps can also be provided as datetime objects.

To see a list of available API methods: `` client.api_methods()

or filter by a specific keyword to see only relevant methods:

client.api_methods(filter="dalmp") ``

By default, the client returns all queries in appropriated typed and logically pivoted pandas DataFrames. You can alter this behavior with the 'as_df' and 'pivot' flags: raw = client.meta_nodes(iso="PJM", as_df=False)

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

isostream-1.0.2.tar.gz (6.6 kB view details)

Uploaded Source

File details

Details for the file isostream-1.0.2.tar.gz.

File metadata

  • Download URL: isostream-1.0.2.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for isostream-1.0.2.tar.gz
Algorithm Hash digest
SHA256 0c58c44fbc8a55fd4d2751223e173ffe69e6aa9c1b939480fe0b10c9d53520a0
MD5 36a00a3f95a2edc21519df2a5bdfc03d
BLAKE2b-256 7d12aa93dccd8f555501366fa807674c66cd12b3bcb2c03289b48ff7834ca116

See more details on using hashes here.

Supported by

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