Skip to main content

Device Information (/api)

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 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

DataTypeDescription
product_typeStringThe type identifier of the product which can be used to customize the user interface. See devices for possible values.
product_nameStringA fixed, user-friendly name that is different from the name set by the user in the app.
serialStringSerial number, also the MAC address. Consists of 12 hexadecimal values.
firmware_versionStringThe current firmware version. Make sure your application can handle other version formats. See versioning and updates.
api_versionStringThe current API version, set to "v1".

Examples

Request
curl http://<IP ADDRESS>/api
Response
HTTP/1.1 200 OK
Content-Type: application/json

{
"product_type": "HWE-P1",
"product_name": "P1 Meter",
"serial": "3c39e7aabbcc",
"firmware_version": "5.18",
"api_version": "v1"
}