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.3.tar.gz (91.8 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.3-py3-none-any.whl (121.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: energyquantified-0.14.3.tar.gz
  • Upload date:
  • Size: 91.8 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.3.tar.gz
Algorithm Hash digest
SHA256 7933e8738a04783594e8c6318016587df0a3551a60df0ee2d29dc6ba26d43f77
MD5 e3d17fdc8fc664ef5b27ee4af1af8c85
BLAKE2b-256 e262bbf5fb54e9489a07606cc32cabe3816bb8d4db1c66d7979948ae26a86749

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for energyquantified-0.14.3-py3-none-any.whl
Algorithm Hash digest
SHA256 38af2a99f1db85e7ae909bbb526824d97ddc73e093a4fecbb07ad3e38e96b8de
MD5 0eebb79a78a6217fe237387ac059e72a
BLAKE2b-256 26426880a6b076e927dd19ebf60911d3d232bc9a20b3d9561a89d443b5c7ce86

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