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.6.tar.gz (92.3 kB view details)

Uploaded Source

Built Distribution

energyquantified-0.14.6-py3-none-any.whl (122.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: energyquantified-0.14.6.tar.gz
  • Upload date:
  • Size: 92.3 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.6.tar.gz
Algorithm Hash digest
SHA256 c8e5fd371e157174775397d5a7d5dbae03f71db8573a69e4e27bd4c542316e2c
MD5 fab4bd81fb5f46bd1792b7b43562e96c
BLAKE2b-256 40855f0269810db614fcf8ef74e20abf2569f415b1b8922be5d4fb320a4bbf22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for energyquantified-0.14.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4e5190be590f76391cd2928b3047058e0d546db8c3ccbed055fe7c762b7716af
MD5 ec1dac1426465e7fdb344febcbff2fd3
BLAKE2b-256 4c5cef896db1a4bda74a48bd4d6131fbabc96b7f72454328f8206ab671d4ac86

See more details on using hashes here.

Supported by

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