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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file volt_client-1.3.1.tar.gz.
File metadata
- Download URL: volt_client-1.3.1.tar.gz
- Upload date:
- Size: 21.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dec550e5de5c665f58e4794c8f21d1bff4efa37e011f9749322cbdcf535eb4cd
|
|
| MD5 |
218b78caf821061158f165208acfa17c
|
|
| BLAKE2b-256 |
6d905a1625960487ea87c0e2bfac1894ceea2a6ed7a85582229a2746d656387a
|
Provenance
The following attestation bundles were made for volt_client-1.3.1.tar.gz:
Publisher:
publish-client.yml on Volt-Power-Analytics/volt-api
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
volt_client-1.3.1.tar.gz -
Subject digest:
dec550e5de5c665f58e4794c8f21d1bff4efa37e011f9749322cbdcf535eb4cd - Sigstore transparency entry: 1260102328
- Sigstore integration time:
-
Permalink:
Volt-Power-Analytics/volt-api@91360ba32e256b089668d646bf86ddade0f93a87 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Volt-Power-Analytics
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@91360ba32e256b089668d646bf86ddade0f93a87 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file volt_client-1.3.1-py3-none-any.whl.
File metadata
- Download URL: volt_client-1.3.1-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c2ec297bcffbcd011353b0740ce22cf52b7e912b7e1024a122ab2c967b349db
|
|
| MD5 |
4ab645a3c6611e7693cfe8e8812c891f
|
|
| BLAKE2b-256 |
74c15ed06cc96db17ed03731e9359ef5465d74d1e9d7eba5da665bbbe9282578
|
Provenance
The following attestation bundles were made for volt_client-1.3.1-py3-none-any.whl:
Publisher:
publish-client.yml on Volt-Power-Analytics/volt-api
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
volt_client-1.3.1-py3-none-any.whl -
Subject digest:
4c2ec297bcffbcd011353b0740ce22cf52b7e912b7e1024a122ab2c967b349db - Sigstore transparency entry: 1260102404
- Sigstore integration time:
-
Permalink:
Volt-Power-Analytics/volt-api@91360ba32e256b089668d646bf86ddade0f93a87 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Volt-Power-Analytics
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@91360ba32e256b089668d646bf86ddade0f93a87 -
Trigger Event:
workflow_dispatch
-
Statement type: