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 spot prices
df = client.get_actual(
    "price spot no1 nordpool eur mwh 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(
    "price spot no1 nordpool eur mwh 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(
    ["price spot no1...", "price spot no2...", "price spot no3..."],
    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.0.0.tar.gz (16.0 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.0.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for volt_client-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a2d631630206fe539965775461fef4645974c1203492181b7f6c252435b4330b
MD5 13051bdcadab65185e945b8e8f0a5d48
BLAKE2b-256 38d1b0822950c7579859831496fc154976f41cbfca79e67ddf8429b569b01562

See more details on using hashes here.

Provenance

The following attestation bundles were made for volt_client-1.0.0.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.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for volt_client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e368f8c5875a48b92e387b9e528c5364996fc5ddbcf8ca7fad4037ef97eae29
MD5 67b7dab10128eb3c0e360394ef0b7909
BLAKE2b-256 34a302edb0f1434ace502e768328d11ddfc87ecb87ddd963bfea01a778459fd7

See more details on using hashes here.

Provenance

The following attestation bundles were made for volt_client-1.0.0-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