Skip to main content

Energy Quantified Time series API client.

Project description

Energy Quantified Python Client

Apache License version 2.0 Python 3.7+ Wheel

Documentation | Python package | GitHub repository

The Python library for Energy Quantified's Time Series API. It allows you to access thousands of data series directly from Energy Quantified's time series database. It integrates with the popular pandas library and the polars libarary for high-performance data analysis and manipulation.

Developed for Python 3.7+.

from datetime import date, timedelta
from energyquantified import EnergyQuantified

# Initialize client
eq = EnergyQuantified(api_key='<insert api key here>')

# Freetext search (filtering on attributes is also supported)
curves = eq.metadata.curves(q='de wind production actual')

# Load time series data
curve = curves[0]
timeseries = eq.timeseries.load(
    curve,
    begin=date.today() - timedelta(days=10),
    end=date.today()
)

# Convert to Pandas data frame
pd_df = timeseries.to_pandas_dataframe()

# Convert to Polars data frame
pl_df = timeseries.to_polars_dataframe()

Full documentation available at Read the Docs.

Features

  • Simple authentication
  • Metadata caching
  • Rate-limiting and automatic retries on network errors
  • Full-text search and keyword search for curves and powerplants
  • Forecasts- and time series data
  • Period-based data
  • OHLC data with SRMC calculations
  • Shows your subscription for each data series
  • Support for timezones, resolutions, aggregations and unit conversions
  • Easy-to-use filters for issue dates and forecast types
  • Push feed for live updates on data modifications
  • Integrates with pandas and polars

Note: A user account with an API key is required to use this library. Create an account on Energy Quantified's home page. Trial users get access to 30 days of history.

Installation

Install with pip:

# Install
pip install energyquantified

# Upgrade
pip install --upgrade energyquantified

Documentation

Find the documentation at Read the Docs.

License

The Energy Quantified Python client is licensed under the Apache License version 2.0.

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

energyquantified-0.14.4.tar.gz (91.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

energyquantified-0.14.4-py3-none-any.whl (121.9 kB view details)

Uploaded Python 3

File details

Details for the file energyquantified-0.14.4.tar.gz.

File metadata

  • Download URL: energyquantified-0.14.4.tar.gz
  • Upload date:
  • Size: 91.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for energyquantified-0.14.4.tar.gz
Algorithm Hash digest
SHA256 8d69e71a5a4cb82bafab2ff67ade12b303031bba33c77e979aa83c44c27e6636
MD5 88f1ea85589520d1349427666650cb5f
BLAKE2b-256 306bdf037a78499a0654793ea883d79cce0457d7b3294f2203fe1ca435984351

See more details on using hashes here.

File details

Details for the file energyquantified-0.14.4-py3-none-any.whl.

File metadata

File hashes

Hashes for energyquantified-0.14.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b1469ac2d2915d52ac7f1896bf12c82aefb89814e176705714ccd1aba6808eea
MD5 1afe3e27ecfce2dcb38b0b607754214f
BLAKE2b-256 87bac9615c3c77e0600b70237e1ca245e227c20547b1c18a1777c6bb7911935b

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