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.1.tar.gz (91.3 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.1-py3-none-any.whl (121.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: energyquantified-0.14.1.tar.gz
  • Upload date:
  • Size: 91.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.1.tar.gz
Algorithm Hash digest
SHA256 ed9811b03625d1f993421cc92936f595be8db9f5170f4eb716de3129dde1106e
MD5 84e70755d8036fa669f82e3d4a98667d
BLAKE2b-256 aab4160973442d4889d2bbe7e820d4e1be3050ca7babba3915dced651b33a194

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for energyquantified-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6179d302a70c52b09cf652b35b99f58ba909208b0c1cfde34c58d6028b72f98
MD5 1e11cb7f22b9a88de9ce6b0b22e68fe9
BLAKE2b-256 7bf299313e52cb2d66f61aede67bf301f472dec61536f4ace9f37f38693bdf78

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