Skip to content
Documentation

Upgrade to 3.0.0

Version 3.0.0 connects to the Volue Data & Forecasts API at https://data-forecasts.volue.com. Versions before 3.0.0 do not work with this address, even if you change urlbase in your config file: they call API paths that data-forecasts.volue.com does not serve. Upgrade to 3.0.0.

Do the steps in this order.

Check that your Python version is supported. See Installation.

If you use the wapi-python package, uninstall it first:

Terminal window
pip uninstall wapi-python

Install the library with the pandas extra:

Terminal window
pip install -U "volue-insight-timeseries[pandas]~=3.0"

~=3.0 installs the latest 3.x release, but not 4.0 or later. A new major version can contain breaking changes, so upgrade to it only after you have checked it.

If you use a requirements.txt file, limit it to the same major version:

volue-insight-timeseries[pandas]~=3.0

The pandas extra installs pandas. Without it, functions such as TS.to_pandas() raise an ImportError. Leave out [pandas] only if your code does not use these functions. See pandas support.

If your code already imports volue_insight_timeseries, skip this step.

Change the imports:

wapi-python volue-insight-timeseries
import wapi import volue_insight_timeseries as vit
wapi.Session(...) vit.Session(...)
from wapi.util import TS from volue_insight_timeseries.util import TS
from wapi.curves import InstanceCurve from volue_insight_timeseries.curves import InstanceCurve

Time zones use zoneinfo, not pytz. TS.tz is a zoneinfo.ZoneInfo object. Replace pytz code:

pytz zoneinfo
pytz.timezone('CET') ZoneInfo('CET')
tz.localize(d) d.replace(tzinfo=tz)
tz.normalize(d) not needed, remove it

All other calls, such as search, get_curve, get_data, get_latest and events, stay the same.

In your config file, delete the urlbase line:

[common]
urlbase = https://api.volueinsight.com
auth_type = OAuth
timeout = 300
[OAuth]
id = client_id
secret = client_secret
auth_urlbase = https://auth.volueinsight.com

The library then uses https://data-forecasts.volue.com. Keep auth_urlbase and your credentials as they are.

If you pass urlbase in code, remove it:

session = vit.Session(config_file='config.ini')

If urlbase still points to api.volueinsight.com, the library shows a FutureWarning when you create the session. The calls work until the cutoff in the migration timeline.

If your network limits outbound traffic, allow HTTPS (port 443) to:

  • data-forecasts.volue.com
  • app.data-forecasts.volue.com
import volue_insight_timeseries as vit
session = vit.Session(config_file='config.ini')
print(session.urlbase) # https://data-forecasts.volue.com
print(len(session.get_areas())) # a number above 0

If both lines print as shown, the upgrade is complete.

© 2026 Volue.Version v0.6.38017 November 2026