Energy Hub Alliance

API Reference

Partner Portal

Support

Vehicle image

API Key

Welcome to the Energy Hub Alliance Developer Portal!

Introduction

The Energy Hub Alliance lets you connect all kinds of energy vendors to your application. Follow these first steps, to set up your application environment.

Quickstart

The Energy Hub Alliance lets you connect all kinds of energy vendors to your application. This page lists the currently available integrations and their capabilities.

Capabilities

Connect offers the and most transparent and customizable method for to connect user energy devices and accounts.

Connect and Link Sequence

Integrate the streaming so your application can receive updates about connected devices in close to real-time, without having to query the Energy Hub Alliance API repeatedly.

The Energy Hub Alliance provides different event types to notify about the status of your devices and connections.

Event types

Errors

Returns the list of vendors which are currently be supported grouped by type. This list is extended when new vendors are added to the Energy Hub Alliance.

All available vendors

Creates a connect Url to redirect to the IDP of the specified vehicle vendor.

Connect session for a vehicle vendor

Returns connected vehicles for the vendor account directly from vendor system.

List vehicles from vendor

Connects the provided list of vehicles from the vendor account to the Energy Hub Alliance.

Link vehicles

Returns vehicle data of a single vehicle.

Vehicle data

This endpoint creates a command request that is asynchronously executed.

Submit command for vehicle

Returns a paginated list of all vehicles of the subscription.

All vehicles

Updates vehicle with newest data from vendor system.

Refresh vehicle data

Delete vehicle

Returns vehicle data of a single vehicle for the user.

Vehicle data for user

Returns the vehicle image as png file for the user.

Vehicle image for user

Returns a paginated list of all vehicles for the user.

All vehicles for user

Updates vehicle with newest data from vendor system for the user.

Refresh vehicle data for user

Delete vehicle for user

Creates a connect URL to redirect to the IDP of the specified tariff vendor.

Connect session for a tariff vendor

Returns tariffs for vendor account directly from vendor API

Link list of tariffs from end user`s vendor account

Link tariffs from vendor account

Tariff data

Returns a paginated list of consumption of a tariff in hourly periods. The list is sorted in the way that the latest records are shown first.

Consumption

Returns a paginated list of all tariffs of subscription.

All tariffs

Prices

Delete tariff

Returns general data of a single tariff for the user.

Tariff data for user

Returns a paginated list of consumption of a tariff in hourly periods for the user.The list is sorted in the way that the latest records are shown first.

Consumption for user

Returns a paginated list of all tariffs that belong to the user.

All tariffs for user

Prices for user

Delete tariff for user

Creates a connect URL to redirect to the IDP of the specified HVAC vendor.

Connect session for a HVAC vendor

Returns connected HVACs for the vendor account directly from vendor system.

List HVACs from vendor

Links the provided list of HVACs from the vendor account to the Energy Hub Alliance.

Link HVACs

HVAC data

HVAC image

Submit command to change mode of HVAC

Submit command to change schedule of HVAC

Submit command to change temperature of HVAC

All HVACs

Updates HVAC with newest data from vendor system.

Refresh HVAC data

Schedules of HVAC

Delete HVAC

Returns a paginated list of all HVACs that belong to the user.

All HVACs for user

Returns the HVAC image as png file for the user.

HVAC image for user

Schedules of user and HVAC

Updates HVAC with newest data from vendor system for the user.

Refresh HVAC data for user

Returns general data of a single HVAC for the user.

HVAC data for user

Delete HVAC for user

Creates a connect URL to redirect to the IDP of the specified EV charger vendor.

Connect session for a EV charger vendor

Returns connected chargers for the vendor account directly from vendor system.

List chargers from vendor

Links the provided list of chargers from the vendor account to the Energy Hub Alliance.

Link chargers

Returns general data of a single charger.

Charger data

Returns a paginated list of all chargers.

All chargers

Updates charger with newest data from vendor system.

Refresh charger data

Submit command for charger

Delete charger

Returns general data of a single charger for the user.

Charger data for user

Returns a paginated list of all chargers that belong to the user.

All chargers for user

Updates charger with newest data from vendor system for the user.

Refresh charger data for user

Delete charger for user

Creates a connect URL to redirect to the IDP of the specified home power vendor.

Connect session for a home power vendor

Returns connected PV inverters for the vendor account directly from vendor system.

List PV inverters from vendor

Returns connected batteries for the vendor account directly from vendor system.

List batteries from vendor

Returns connected meters for the vendor account directly from vendor system.

List meters from vendor

Links the provided list of PV inverters from the vendor account to the Energy Hub Alliance.

Link PV inverters

Links the provided list of batteries from the vendor account to the Energy Hub Alliance.

Link batteries

Links the provided list of meters from the vendor account to the Energy Hub Alliance.

Link meters

Returns PV inverter data of a single PV inverter.

PV inverter data

Returns a paginated list of all PV inverters of the subscription.

All PV inverters

Updates PV inverter with newest data from vendor system.

Refresh PV inverter data

Delete PV inverter

Returns PV inverter data of a single PV inverter for the user.

PV inverter data for user

Returns a paginated list of all PV inverters for the user.

All PV inverters for user

Updates PV inverter with newest data from vendor system for the user.

Refresh PV inverter data for user

Delete PV inverter for user

Returns general data of a single battery.

Get battery data

Returns a paginated list of all batteries.

All batteries

Updates battery with newest data from vendor system.

Refresh battery data

Delete battery

Returns general data of a single battery for the user.

Battery data for user

Returns a paginated list of all batteries that belong to the user.

All batteries for user

Updates battery with newest data from vendor system for the user.

Refresh battery data for user

Delete battery for user

Meter data

All meters

Updates meter with newest data from vendor system.

Refresh meter data

Delete meter

Returns general data of a single meter for the user.

Meter data for user

Returns a paginated list of all meters that belong to the user.

All meters for user

Updates meter with newest data from vendor system for the user.

Refresh meter data for user

Delete meter for user

Send notification for deletion of all user devices and data

Introduction

Capabilities

Vehicles

Tariffs

HVACs

Chargers

Home Power Devices

User

Vehicle image

Authorizations

Path Parameters

Response