evervolt

Evervolt API documentation

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.7
• Generator version: 7.19.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import evervolt

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import evervolt

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import evervolt
from evervolt.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.evervolt.nl
# See configuration.py for a list of all supported configuration parameters.
configuration = evervolt.Configuration(
    host = "https://api.evervolt.nl"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'


# Enter a context with an instance of the API client
async with evervolt.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = evervolt.CustomerApi(api_client)

    try:
        # Get customer
        api_response = await api_instance.customer_get()
        print("The response of CustomerApi->customer_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CustomerApi->customer_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.evervolt.nl

Class	Method	HTTP request	Description
CustomerApi	customer_get	GET /customer	Get customer
DevicesApi	devices_delete	DELETE /devices	Delete device
DevicesApi	devices_get	GET /devices	Get devices
DevicesApi	devices_post	POST /devices	Add device
PricesApi	energy_prices_post	POST /energy/prices	Electricity prices
PricesApi	energy_schedule_post	POST /energy/schedule	Optimal schedule
PricesApi	energy_starttime_post	POST /energy/starttime	Optimal start time
ProvidersApi	providers_get	GET /providers	Get providers

Documentation For Models

• DevicesDeleteRequest
• DevicesPostRequest
• EnergyPricesPostRequest
• EnergySchedulePostRequest
• EnergySchedulePostRequestSplittableUsage
• EnergyStarttimePostRequest
• InlineObject
• InlineObject1
• InlineObject1Inner
• InlineObject2
• InlineObject3Inner
• Providers
• ScheduleSlot
• UsageProfileInner

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

Author