Skip to main content
POST
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
batteries
Link batteries
curl --request POST \
  --url https://api.energy-hub.io/v1.0.0/link/users/{userId}/vendor-accounts/{vendorAccountId}/batteries \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "externalBatteries": [
    "8413731391660801"
  ]
}'
[
  {
    "isLinked": true,
    "vendor": "FRONIUS",
    "name": "My battery",
    "externalId": "8413731391660801",
    "siteName": "My Home",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

​
userId
string
required

User ID

​
vendorAccountId
string<uuid>
required

Vendor account ID

Body

application/json

Object for batteries IDs request that should be added to the Energy Hub.

​
externalBatteries
string[]
required

List of external IDs of batteries to be linked to the Energy Hub.

List of external IDs of batteries to be linked to the Energy Hub.

Example:
["8413731391660801"]

Response

Created

​
isLinked
boolean
required

Indicates if the battery is linked to the Energy Hub.

​
vendor
enum<string>
required

The vendor of the battery.

Available options:
FRONIUS,
TESLA,
HUAWEI,
SMA
​
name
string
required

The display name of the battery.

Example:

"My battery"

​
externalId
string
required

The ID of the battery in external vendor system.

Example:

"8413731391660801"

​
id
string<uuid>
required

The ID of the battery.

​
siteName
string

The site name of the home energy device.

Example:

"My Home"