Recent Measurement (`/api/v1/data`)

P1 Meter

Supported

Energy Socket

Supported

Energy Display

Not supported

kWh Meter

Supported

Watermeter

Supported

Plug-In Battery

Supported in v2

_{See Supported Devices for more information.}

The /api/v1/data endpoint allows you to get the most recent measurement from the device. All data points are "optional"; The API does not send data points that are null or not available at all. This mostly depends on the connected smart meter. Make sure your application can handle this.

P1 Meter (HWE-P1)

Parameters

Data	Type	Description
unique_id	String	The unique identifier from the smart meter.
smr_version	Number	The DSMR version of the smart meter.
meter_model	String	The brand identification the smart meter.
wifi_ssid	String	The Wi-Fi network that the meter is connected to.
wifi_strength	Number	The strength of the Wi-Fi signal in %.
total_power_import_kwh	Number	The energy usage meter reading for all tariffs in kWh.
total_power_import_t1_kwh	Number	The energy usage meter reading for tariff 1 in kWh.
total_power_import_t2_kwh	Number	The energy usage meter reading for tariff 2 in kWh.
total_power_import_t3_kwh	Number	The energy usage meter reading for tariff 3 in kWh.
total_power_import_t4_kwh	Number	The energy usage meter reading for tariff 4 in kWh.
total_power_export_kwh	Number	The energy feed-in meter reading for all tariffs in kWh.
total_power_export_t1_kwh	Number	The energy feed-in meter reading for tariff 1 in kWh.
total_power_export_t2_kwh	Number	The energy feed-in meter reading for tariff 2 in kWh.
total_power_export_t3_kwh	Number	The energy feed-in meter reading for tariff 3 in kWh.
total_power_export_t4_kwh	Number	The energy feed-in meter reading for tariff 4 in kWh.
active_power_w	Number	The total active usage in watt.
active_power_l1_w	Number	The active usage for phase 1 in watt.
active_power_l2_w	Number	The active usage for phase 2 in watt.
active_power_l3_w	Number	The active usage for phase 3 in watt.
active_voltage_l1_v	Number	The active voltage for phase 1 in volt.
active_voltage_l2_v	Number	The active voltage for phase 2 in volt.
active_voltage_l3_v	Number	The active voltage for phase 3 in volt.
active_current_l1_a	Number	The active current for phase 1 in ampere.
active_current_l2_a	Number	The active current for phase 2 in ampere.
active_current_l3_a	Number	The active current for phase 3 in ampere.
active_frequency_hz	Number	Line frequency in hertz.
voltage_sag_l1_count	Number	Number of voltage sags detected by meter for phase 1.
voltage_sag_l2_count	Number	Number of voltage sags detected by meter for phase 2.
voltage_sag_l3_count	Number	Number of voltage sags detected by meter for phase 3.
voltage_swell_l1_count	Number	Number of voltage swells detected by meter for phase 1.
voltage_swell_l2_count	Number	Number of voltage swells detected by meter for phase 2.
voltage_swell_l3_count	Number	Number of voltage swells detected by meter for phase 3.
any_power_fail_count	Number	Number of power failures detected by meter.
long_power_fail_count	Number	Number of 'long' power fails detected by meter.
active_power_average_w	Number	The active average demand.
montly_power_peak_w	Number	The peak average demand of this month. There is a spelling mistake with this data point, see monthly power peak for more information.
montly_power_peak_timestamp	Number	Timestamp when peak demand was registered, formatted as YYMMDDhhmmss. There is a spelling mistake with this data point, see monthly power peak for more information.
total_gas_m3	Number	The gas meter reading in m3 for the first detected gas meter.
gas_timestamp	Number	The most recent gas update time stamp structured as YYMMDDhhmmss.
unique_gas_id	Number	The unique identifier for the gas meter, can be used to migrate to the 'external' data point.
external	Array	A list of externally connected utility meters, see external data point for more information.

External Devices

Some smart meters have more than one external device connected to it. This can be, for example, a gas and a water meter. The external data point adds support for these devices. Each entry is supplied with a set of data. See this example.

Data	Type	Description
unique_id	String	The unique identifier from this device.
type	String	The type of the device, can be `gas_meter` `heat_meter` `warm_water_meter` `water_meter` or `inlet_heat_meter`.
timestamp	Number	The most recent value update time stamp structured as YYMMDDhhmmss.
value	Number	The raw value.
unit	String	The unit of the value, for example: "m3" or "GJ".

The original data points total_gas_m3, gas_timestamp and unique_gas_id use the first detected gas meter. These data points will be removed in a future version. You can use unique_id to migrate any values if needed.

Monthly Power Peak

Belgian users are started to get charged for the peak usage per month (see capaciteitstarief). The data points active_power_average_w, montly_power_peak_w and montly_power_peak_timestamp can be used to track the maximum demand.

Examples

HWE-P1 (1-phase, no gas)

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
   "smr_version": 50,
   "meter_model": "ISKRA  2M550T-101",
   "wifi_ssid": "My Wi-Fi",
   "wifi_strength": 100,
   "total_power_import_t1_kwh": 10830.511,
   "total_power_import_t2_kwh": 2948.827,
   "total_power_export_t1_kwh": 1285.951,
   "total_power_export_t2_kwh": 2876.51,
   "active_power_w": -678,
   "active_power_l1_w": -676,
}

HWE-P1 (3-phase, with gas and water meter)

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
   "wifi_ssid": "My Wi-Fi",
   "wifi_strength": 100,
   "smr_version": 50,
   "meter_model": "ISKRA  2M550T-101",
   "unique_id": "00112233445566778899AABBCCDDEEFF",
   "active_tariff": 2,
   "total_power_import_kwh": 13779.338,
   "total_power_import_t1_kwh": 10830.511,
   "total_power_import_t2_kwh": 2948.827,
   "total_power_export_kwh": 0,
   "total_power_export_t1_kwh": 0,
   "total_power_export_t2_kwh": 0,
   "active_power_w": -543,
   "active_power_l1_w": -676,
   "active_power_l2_w": 133,
   "active_power_l3_w": 0,
   "active_current_l1_a": -4,
   "active_current_l2_a": 2,
   "active_current_l3_a": 0,
   "voltage_sag_l1_count": 1,
   "voltage_sag_l2_count": 1,
   "voltage_sag_l3_count": 0,
   "voltage_swell_l1_count": 0,
   "voltage_swell_l2_count": 0,
   "voltage_swell_l3_count": 0,
   "any_power_fail_count": 4,
   "long_power_fail_count": 5,
   "total_gas_m3": 2569.646,
   "gas_timestamp": 210606140010,
   "gas_unique_id": "FFEEDDCCBBAA99887766554433221100",
   "active_power_average_w": 123.000,
   "montly_power_peak_w": 1111.000,
   "montly_power_peak_timestamp": 230101080010,
   "external": [
      {
         "unique_id": "FFEEDDCCBBAA99887766554433221100",
         "type": "gas_meter",
         "timestamp": 210606140010,
         "value": 2569.646,
         "unit": "m3"
      },
      {
         "unique_id": "ABCDEF0123456789ABCDEF0123456789",
         "type": "water_meter",
         "timestamp": 210606140015,
         "value": 123.456,
         "unit": "m3"
      }
   ]
}

Energy Socket (HWE-SKT)

Parameters

Data	Type	Available for	Description
wifi_ssid	String	All	The Wi-Fi network that the meter is connected to
wifi_strength	Number	All	The strength of the Wi-Fi signal in %
total_power_import_kwh	Number	All	The energy usage meter reading in kWh
total_power_import_t1_kwh	Number	All	Same value as `total_power_import_kwh`, kept for backwards compatibility
total_power_export_kwh	Number	All	The energy feed-in meter reading in kWh
total_power_export_t1_kwh	Number	All	Same value as `total_power_export_kwh`, kept for backwards compatibility
active_power_w	Number	All	The total active usage in watt
active_power_l1_w	Number	All	Same value as `active_power_w`, kept for backwards compatibility
active_voltage_v	Number	All	The active voltage in volts
active_current_a	Number	All	The active current in amperes
active_reactive_power_var	Number	HWE-SKT-21	The reactive power in volt-amperes reactive
active_apparent_power_va	Number	HWE-SKT-21	The apparent power in volt-amperes
active_power_factor	Number	HWE-SKT-21	The power factor
active_frequency_hz	Number	All	The frequency in hertz

Examples

HWE-SKT-11

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
   "wifi_ssid": "My Wi-Fi",
   "wifi_strength": 100,
   "total_power_import_kwh": 30.511,
   "total_power_import_t1_kwh": 30.511,
   "total_power_export_kwh": 85.951,
   "total_power_export_t1_kwh": 85.951,
   "active_power_w": 543.312,
   "active_power_l1_w": 543.312,
   "active_voltage_v": 231.539,
   "active_current_a": 2.346,
   "active_frequency_hz": 50.005
}

HWE-SKT-21

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
   "wifi_ssid": "My Wi-Fi",
   "wifi_strength": 100,
   "total_power_import_kwh": 30.511,
   "total_power_import_t1_kwh": 30.511,
   "total_power_export_kwh": 85.951,
   "total_power_export_t1_kwh": 85.951,
   "active_power_w": 543.312,
   "active_power_l1_w": 543.312,
   "active_voltage_v": 231.539,
   "active_current_a": 2.346,
   "active_reactive_power_var": 123.456,
   "active_apparent_power_va": 666.768,
   "active_power_factor": 0.81688,
   "active_frequency_hz": 50.005
}

kWh Meters (1 and 3 phase)

Each type of meter is available in two versions. The API and functionality is the same for both types.

1-phase: HWE-KWH1 and SDM230-wifi
3-phase: HWE-KWH3 and SDM630-wifi

Parameters

Data	Type	Available for	Description
wifi_ssid	String	1-phase, 3-phase	The Wi-Fi network that the meter is connected to.
wifi_strength	Number	1-phase, 3-phase	The strength of the Wi-Fi signal in %.
total_power_import_kwh	Number	1-phase, 3-phase	The energy usage meter reading in kWh.
total_power_import_t1_kwh	Number	1-phase, 3-phase	Same value as `total_power_import_t1_kwh`, kept for backwards compatibility.
total_power_export_kwh	Number	1-phase, 3-phase	The energy feed-in meter reading in kWh.
total_power_export_t1_kwh	Number	1-phase, 3-phase	Same value as `total_power_export_kwh`, kept for backwards compatibility.
active_power_w	Number	1-phase, 3-phase	The total active usage in watt.
active_power_l1_w	Number	1-phase, 3-phase	The active usage for phase 1 in watt, same as `active_power_w` for 1-phase.
active_power_l2_w	Number	3-phase	The active usage for phase 2 in watt.
active_power_l3_w	Number	3-phase	The active usage for phase 3 in watt.
active_voltage_v	Number	1-phase	The active voltage in volts.
active_voltage_l1_v	Number	3-phase	The active voltage for phase 1 in volts.
active_voltage_l2_v	Number	3-phase	The active voltage for phase 2 in volts.
active_voltage_l3_v	Number	3-phase	The active voltage for phase 3 in volts.
active_current_a	Number	1-phase, 3-phase	The active current in amperes, the sum of all phases for 3-phase.
active_current_l1_a	Number	3-phase	The active current for phase 1 in amperes.
active_current_l2_a	Number	3-phase	The active current for phase 2 in amperes.
active_current_l3_a	Number	3-phase	The active current for phase 3 in amperes.
active_apparent_current_a	Number	1-phase, 3-phase	The apparent current in amperes, the sum of all phases for 3-phase.
active_apparent_current_l1_a	Number	3-phase	The apparent current for phase 1 in amperes.
active_apparent_current_l2_a	Number	3-phase	The apparent current for phase 2 in amperes.
active_apparent_current_l3_a	Number	3-phase	The apparent current for phase 3 in amperes.
active_reactive_current_a	Number	1-phase, 3-phase	The reactive current in amperes, the sum of all phases for 3-phase.
active_reactive_current_l1_a	Number	3-phase	The reactive current for phase 1 in amperes.
active_reactive_current_l2_a	Number	3-phase	The reactive current for phase 2 in amperes.
active_reactive_current_l3_a	Number	3-phase	The reactive current for phase 3 in amperes.
active_apparent_power_va	Number	1-phase, 3-phase	The apparent power in volt-amperes, the sum of all phases for 3-phase.
active_apparent_power_l1_va	Number	3-phase	The apparent power for phase 1 in volt-amperes.
active_apparent_power_l2_va	Number	3-phase	The apparent power for phase 2 in volt-amperes.
active_apparent_power_l3_va	Number	3-phase	The apparent power for phase 3 in volt-amperes.
active_reactive_power_var	Number	1-phase, 3-phase	The reactive power in volt-amperes reactive, the sum of all phases for 3-phase.
active_reactive_power_l1_var	Number	3-phase	The reactive power for phase 1 in volt-amperes reactive.
active_reactive_power_l2_var	Number	3-phase	The reactive power for phase 2 in volt-amperes reactive.
active_reactive_power_l3_var	Number	3-phase	The reactive power for phase 3 in volt-amperes reactive.
active_power_factor	Number	1-phase	The power factor.
active_power_factor_l1	Number	3-phase	The power factor for phase 1.
active_power_factor_l2	Number	3-phase	The power factor for phase 2.
active_power_factor_l3	Number	3-phase	The power factor for phase 3.
active_frequency_hz	Number	1-phase, 3-phase	The frequency in hertz.

Examples

1-phase

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
    "wifi_ssid": "My Wi-Fi",
    "wifi_strength": 74,
    "total_power_import_kwh": 122.376,
    "total_power_import_t1_kwh": 122.376,
    "total_power_export_kwh": 579.813,
    "total_power_export_t1_kwh": 579.813,
    "active_power_w": -45.252,
    "active_power_l1_w": -45.252,
    "active_voltage_v": 228.472,
    "active_current_a": 0.273,
    "active_apparent_current_a": 0.447,
    "active_reactive_current_a": 0.354,
    "active_apparent_power_va": 74.052,
    "active_reactive_power_var": -58.612,
    "active_power_factor": 0.611,
    "active_frequency_hz": 50
}

3-phase

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
    "wifi_ssid": "HW WiFi",
    "wifi_strength": 84,
    "total_power_import_kwh": 2940.101,
    "total_power_import_t1_kwh": 2940.101,
    "total_power_export_kwh": 0,
    "total_power_export_t1_kwh": 0,
    "active_power_w": 7100.278,
    "active_power_l1_w": 0,
    "active_power_l2_w": 3547.015,
    "active_power_l3_w": 3553.263,
    "active_voltage_l1_v": 230.751,
    "active_voltage_l2_v": 228.391,
    "active_voltage_l3_v": 229.612,
    "active_current_a": 30.999,
    "active_current_l1_a": 0,
    "active_current_l2_a": 15.521,
    "active_current_l3_a": 15.477,
    "active_apparent_current_a": 31.058,
    "active_apparent_current_l1_a": 0,
    "active_apparent_current_l2_a": 15.539,
    "active_apparent_current_l3_a": 15.519,
    "active_reactive_current_a": 1.872,
    "active_reactive_current_l1_a": 0,
    "active_reactive_current_l2_a": 0.73,
    "active_reactive_current_l3_a": 1.143,
    "active_apparent_power_va": 7112.293,
    "active_apparent_power_l1_va": 0,
    "active_apparent_power_l2_va": 3548.879,
    "active_apparent_power_l3_va": 3563.414,
    "active_reactive_power_var": -429.025,
    "active_reactive_power_l1_var": 0,
    "active_reactive_power_l2_var": -166.675,
    "active_reactive_power_l3_var": -262.35,
    "active_power_factor_l1": 1,
    "active_power_factor_l2": 0.999,
    "active_power_factor_l3": 0.997,
    "active_frequency_hz": 49.926
}

Watermeter (HWE-WTR)

API is not available when using batteries

The API for the Watermeter can only be used when the Watermeter is powered over USB. To save energy, the Watermeter only connects to Wi-Fi a couple of times per day when powered by batteries.

Parameters

Data	Type	Description
wifi_ssid	String	The Wi-Fi network that the meter is connected to.
wifi_strength	Number	The strength of the Wi-Fi signal in %.
active_liter_lpm	Number	Active water usage in liters per minute.
total_liter_m3	Number	Total water usage in cubic meters since installation.
total_liter_offset_m3	Number	The usage of this value is in development and should not be used.

Example

Request

curl http://<IP ADDRESS>/api/v1/data

Response
HTTP/1.1 200 OK
Content-Type: application/json

{
   "wifi_ssid": "My Wi-Fi",
   "wifi_strength": 100,
   "total_liter_m3": 123.456,
   "active_liter_lpm": 7.2,
   "total_liter_offset_m3": 0
}

P1 Meter (HWE-P1)​

Parameters​

External Devices​

Monthly Power Peak​

Examples​

HWE-P1 (1-phase, no gas)​

HWE-P1 (3-phase, with gas and water meter)​

Energy Socket (HWE-SKT)​

Parameters​

Examples​

HWE-SKT-11​

HWE-SKT-21​

kWh Meters (1 and 3 phase)​

Parameters​

Examples​

1-phase​

3-phase​

Watermeter (HWE-WTR)​

Parameters​

Example​

P1 Meter (HWE-P1)

Parameters

External Devices

Monthly Power Peak

Examples

HWE-P1 (1-phase, no gas)

HWE-P1 (3-phase, with gas and water meter)

Energy Socket (HWE-SKT)

Parameters

Examples

HWE-SKT-11

HWE-SKT-21

kWh Meters (1 and 3 phase)

Parameters

Examples

1-phase

3-phase

Watermeter (HWE-WTR)

Parameters

Example