Device Information `/api`

P1 Meter

Supported

Energy Socket

Supported in v1

Energy Display

In development

kWh Meter

Supported in v1

Watermeter

Supported in v1

Plug-In Battery

In development

_{See Supported Devices for more information.}

warning

The HomeWizard Energy API v2 and its documentation are in beta and subject to change.

The /api endpoint allows you to get basic information from the device.

Your application can use this endpoint to see if your integration is designed to work with this version of the API. You can validate your support based on the combination of product_type and api_version. Data points in this endpoint that are currently available won't change, but make sure your application can accept new data points for future updates.

Parameters

Data	Type	Description
product_name	String	A fixed, user-friendly name. This name is not the same that is set by the user in the app.
product_type	string	The type identifier of the product which can be used to customize the user interface. See devices for possible values.
serial	string	Serial number, also the MAC address. Consists of 12 hexadecimal values.
firmware_version	string	The current firmware version. Make sure your application can handle other version formats. See Versioning and updates
api_version	string	The current API version, currently "2.0.0".

Example

Request
curl https://<IP ADDRESS>/api --insecure \
  -H "Authorization: Bearer <TOKEN>" \
  -H "X-Api-Version: 2" \

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

{
    "product_name": "P1 Meter",
    "product_type": "HWE-P1",
    "serial": "5c2fafaabbcc",
    "firmware_version": "6.00",
    "api_version": "2.0.0"
}

Parameters​

Example​

Parameters

Example