Connection

To work with the API, first create a session. A session can be configured using a config file or by providing your client_id and client_secret directly.

Get the required credentials by creating an OAuth client at auth.volueinsight.com (see the documentation for details).

Using a config file

Create a config file (e.g. yourfilename.ini). The simplest way is to use the sample config file and insert your client_id and client_secret.

Then pass the file path when creating the session:

import volue_insight_timeseries
config_file_path = 'path/to/your/configfile.ini'
session = volue_insight_timeseries.Session(config_file=config_file_path)

Directly using client ID and secret

You can also pass credentials directly:

import volue_insight_timeseries
session = volue_insight_timeseries.Session(
    client_id='client id',
    client_secret='client secret',
    timeout=300
)

The timeout parameter is optional and defaults to 300 seconds. This can also be set in the sample config file.

Using a proxy

The library responds to the standard proxy environment variables (https_proxy, etc.) if they are present.