Refresh battery data

curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/batteries/{batteryId}/refresh \
  --header 'X-API-KEY: <api-key>'

{
  "isOnline": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "staticData": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "vendor": "FRONIUS",
    "name": "My device",
    "model": "Charge",
    "siteName": "My Home",
    "batteryCapacity": 12.5
  },
  "lastUpdated": "2023-11-07T05:31:56Z",
  "chargeState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "mode": "AUTO",
    "chargeRate": 6.512,
    "stateOfCharge": 72.25,
    "chargeLimitMin": 20.25,
    "chargeLimitMax": 80.25,
    "maxChargeRate": 6,
    "maxDischargeRate": 6,
    "chargingState": "CHARGING"
  },
  "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

GET

v1.0.0

batteries

{batteryId}

refresh

Refresh battery data

curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/batteries/{batteryId}/refresh \
  --header 'X-API-KEY: <api-key>'

{
  "isOnline": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "staticData": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "vendor": "FRONIUS",
    "name": "My device",
    "model": "Charge",
    "siteName": "My Home",
    "batteryCapacity": 12.5
  },
  "lastUpdated": "2023-11-07T05:31:56Z",
  "chargeState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "mode": "AUTO",
    "chargeRate": 6.512,
    "stateOfCharge": 72.25,
    "chargeLimitMin": 20.25,
    "chargeLimitMax": 80.25,
    "maxChargeRate": 6,
    "maxDischargeRate": 6,
    "chargingState": "CHARGING"
  },
  "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-API-KEY

string

header

required

API key used for authorization and authentication.

Path Parameters

batteryId

string<uuid>

required

Battery ID

Response

Successful operation

Object of battery response.

isOnline

boolean

required

Indicates if the battery is reachable trough the vendor system.

Example:

true

string<uuid>

required

The ID of the battery.

userId

string

required

The ID of the user.

Example:

"896f9d5a-b618-48a2-98ae-957059bf1bc9"

staticData

object

required

Object of static data of a home energy device.

Show child attributes

staticData.lastUpdated

string<date-time>

required

The timestamp of the last update of the static data.

staticData.vendor

enum<string>

required

The vendor of the home energy device.

Available options:

FRONIUS,

TESLA,

HUAWEI,

SMA

staticData.name

string

required

The display name of the home energy device.

Example:

"My device"

staticData.model

string

required

The model of the home energy device.

Example:

"Charge"

staticData.siteName

string

The site name of the home energy device.

Example:

"My Home"

staticData.batteryCapacity

number<double>

The capacity of battery in kWh.

Example:

12.5

lastUpdated

string<date-time>

The timestamp of the last update of any variable of the battery.

chargeState

object

Object of charge state data of a battery.

Show child attributes

chargeState.lastUpdated

string<date-time>

required

The timestamp of the last update of the battery state data.

chargeState.mode

enum<string>

The mode of the battery.

Available options:

AUTO,

SELF_CONSUMPTION,

EXPORT_FOCUS,

MANUAL

chargeState.chargeRate

number<double>

The charge rate of the battery in kW. Values are negative during discharging and positive during charging of the battery.

Example:

6.512

chargeState.stateOfCharge

number<double>

The state of the charge of the battery in percent.

Example:

72.25

chargeState.chargeLimitMin

number<double>

The minimum state of charge set by the user for the battery in percent.

Example:

20.25

chargeState.chargeLimitMax

number<double>

The maximum state of charge set by the user for the battery in percent.

Example:

80.25

chargeState.maxChargeRate

number<double>

The maximum charge rate of the battery in kW

Example:

6

chargeState.maxDischargeRate

number<double>

The maximum discharge rate of the battery in kW

Example:

6

chargeState.chargingState

enum<string>

The current charging state.

Available options:

CHARGING,

DISCHARGING,

IDLE,

FAULT

Example:

"CHARGING"

locationId

string<uuid>

The location ID of the battery.

All batteries Delete battery

⌘I

Introduction

Capabilities

Vehicles

Tariffs

HVACs

Chargers

Home Power Devices

User

Refresh battery data

Authorizations

Path Parameters

Response