Skip to main content

Energy Quantified Time series API client.

Project description

Energy Quantified Python Client

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 for high-performance data analysis and manipulation.

Developed for Python 3.7+.

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

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
  • (TODO!) OHLC data
  • (TODO!) SRMC, dark- and spark spreads
  • (TODO!) Shows your subscription for each series
  • Support for time-zones, resolutions and aggregations
  • Easy-to-use filters for issue dates and forecast types
  • Integrates with pandas

Documentation

Find the documentation at readthedocs.

Installation

Install with pip:

# Install
pip install energyquantified

# Upgrade
pip install --upgrade energyquantified

Example usage

How to initialize the client, search for data series and download data. More details available in the documentation.

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='germany wind production actual')

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

# Convert to Pandas data frame
df = timeseries.to_dataframe()

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: energyquantified-0.1.tar.gz
  • Upload date:
  • Size: 38.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.5

File hashes

Hashes for energyquantified-0.1.tar.gz
Algorithm Hash digest
SHA256 2d671dc87b9f99ab73af96148dfe9941aece600bbc280a33eabbd6dc18af56fd
MD5 94b81397bd7288d4e68115ea5cd56761
BLAKE2b-256 26f33212c9fda31d6a5ada69df68b2bb35e76896b76befa4421883710cda558d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: energyquantified-0.1-py3-none-any.whl
  • Upload date:
  • Size: 58.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.5

File hashes

Hashes for energyquantified-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e127d4b2b1dee09373c69cd5fd48a9a9c7f639cd90e6771d7560316b532e5cd0
MD5 83111b145f40235eaed718b5bffb29cc
BLAKE2b-256 98498a340aada4a9fabc06758ccc06fa7391dc40a54d4250d2b7407dfda4e27a

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