Skip to main content

Python client for Volt Power Analytics API - Access energy market time series data

Project description

Volt Client

Python client for the Volt Power Analytics API - Access energy market time series data.

Installation

pip install volt-client

Quick Start

import os
from volt_client import VoltClient

# Initialize with your API key
client = VoltClient(api_key=os.environ["VOLT_API_KEY"])

# Get production data
df = client.get_actual(
    "prod biomass be entso-e mw min60 actual",
    start_date="2024-01-01",
    end_date="2024-12-31"
)
print(df.head())

Features

  • Simple Python interface for Volt Power Analytics API
  • Support for historical data, forecasts, and forward curves
  • Bulk queries for efficient data retrieval
  • Timezone conversion and server-side aggregation
  • Returns pandas DataFrames (or polars for better performance)

Usage Examples

Historical Data

# Single curve
df = client.get_actual(
    "prod biomass be entso-e mw min60 actual",
    start_date="2024-01-01",
    end_date="2024-12-31",
    tz="Europe/Oslo",
    agg="daily",
    agg_func="avg"
)

# Multiple curves (bulk query - much faster)
df = client.get_actual(
    ["prod biomass be entso-e mw min60 actual",
     "prod wind onshore be entso-e mw min60 actual",
     "prod solar be entso-e mw min60 actual"],
    start_date="2024-01-01",
    end_date="2024-12-31"
)

Forecast Data

df = client.get_fcast(
    "price no1 volt emps mid-term fcast",
    start_date="2025-01-01",
    end_date="2025-12-31",
    freq="weekly"  # Returns percentiles: avg, p10, p25, p50, p75, p90
)

Forward Curves

df = client.get_closing("price future no1 nasdaq eur mwh close")

Performance Tips

For large datasets, use polars mode (10x faster):

client = VoltClient(api_key="...", use_polars=True)
df = client.get_actual(...)  # Returns polars DataFrame

API Reference

Method Description
get_actual(curve, start, end) Get historical/actual data
get_fcast(curve, start, end) Get forecast data
get_closing(curve) Get forward curve prices
search(area=None) Search available curves
get_areas() List accessible areas
get_groups() List accessible groups

Documentation

Full documentation: https://github.com/Volt-Power-Analytics/volt-api/tree/main/docs

Support

Contact: support@voltanalytics.no

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

volt_client-1.6.2.tar.gz (48.6 kB view details)

Uploaded Source

Built Distribution

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

volt_client-1.6.2-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file volt_client-1.6.2.tar.gz.

File metadata

  • Download URL: volt_client-1.6.2.tar.gz
  • Upload date:
  • Size: 48.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for volt_client-1.6.2.tar.gz
Algorithm Hash digest
SHA256 03402b71ad2ed7b20afb9992e908e368a439bf47cad347c1418db90653984e42
MD5 03068a637966774f03436728047250ee
BLAKE2b-256 1281d2820f7b31bfa84af0716d388fb261dadcf0d4033a4ca8b3e27126aef19e

See more details on using hashes here.

Provenance

The following attestation bundles were made for volt_client-1.6.2.tar.gz:

Publisher: publish-client.yml on Volt-Power-Analytics/volt-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file volt_client-1.6.2-py3-none-any.whl.

File metadata

  • Download URL: volt_client-1.6.2-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for volt_client-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 74ee7f429cdd63af6092dc0f7a90280217f140034a1b89a5e946795ad8656d06
MD5 9a89798cee935641c9bcdc53d4739ffa
BLAKE2b-256 8b008ac220b7c6aa81b732b642105d9a5235c87c619926f3dd9eea03b6436c91

See more details on using hashes here.

Provenance

The following attestation bundles were made for volt_client-1.6.2-py3-none-any.whl:

Publisher: publish-client.yml on Volt-Power-Analytics/volt-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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