Get Energy System (formerly "Ensemble") inventory.
Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.
More details on the project are available from the project’s homepage.
A HTTP GET to the /ivp/ensemble/inventory endpoint provides the following response data.
As of recent Gateway software versions this request requires user authentication and authorisation, see Authentication.
| Name | Type | Values | Description |
|---|---|---|---|
|
String |
|
The type of products this is a list for (this will exclude any AC Battery). In the format |
|
Array(Object) |
Array of |
The list of devices for this DeviceType category. |
|
String |
String |
The grid profile name for the whole energy system. |
|
String |
String |
The ID number for the grid profile. |
|
String |
String |
The version number of the grid profile. |
|
Number |
Number |
How many grid profiles are available. |
| Name | Type | Values | Description |
|---|---|---|---|
|
String |
String |
The Enphase® part number for this product. |
|
Number |
Number |
The unix epoch timestamp this device was installed. |
|
String |
String |
The serial number of this product. |
|
Array(String) |
Array of String |
An array of states the device is currently in. In the format |
|
Number |
Number |
The unix epoch timestamp of when this device last reported to this Gateway. |
|
Number |
Number |
The numerical administrative state this device is in. |
|
String |
String |
The string representation of the administrative state this device is in. |
|
Number |
Number |
The date this product was created. |
|
Number |
Number |
The date the firmware image was loaded onto this device. |
|
String |
String |
The software product number this is running. |
|
String |
String |
The firmware version information for the Zigbee dongle this device has installed. |
|
Boolean |
Boolean (e.g. |
Whether or not the product is operating. |
|
Boolean |
Boolean (e.g. |
Whether or not this product is currently communicating with the Gateway. |
|
Boolean |
Boolean (e.g. |
Whether the device is currently in sleep mode. |
|
Number |
Number |
How full in percent this device is charged. |
|
Number |
Number |
The temperature of the overall device. |
|
Number |
Number |
The maximum cell temperature of the cells within this battery. |
|
Number |
Number |
The sub-GHz (Zigbee is 915Mhz in the Americas and 868Mhz in Europe) signal level. |
|
Number |
Number |
The 2.4 GHz WiFi signal level. |
|
Number |
Number |
The status of the LEDs. |
|
Number |
Number |
The current power charging/discharging (in Watts). |
|
Boolean |
Boolean (e.g. |
Whether the Direct Current (DC) switch is off. |
|
Number |
Number |
The revision of the IQ Battery (formerly "Encharge Storage"). |
|
Number |
Number |
The capacity of the IQ Battery (formerly "Encharge Storage"). |
|
String |
String |
The administrative state of the mains relay. |
|
String |
String |
The operational state of the mains relay. |
|
String |
String |
The status of the grid on the IQ System Controller (formerly "Enpower"). |
|
String |
String |
The status of the microinverter on the IQ Battery (formerly "Encharge Storage"). |
|
Number |
Number |
The IQ System Controller (formerly "Enpower") relay state |
|
Number |
Number |
The IQ System Controller (formerly "Enpower") current state |
[{"type": "ENCHARGE", "devices": [{"part_num": "830-00703-r67", "installed": 1621354342, "serial_num": "xxx", "device_status": ["envoy.global.ok", "prop.done"], "last_rpt_date": 1621464675, "admin_state": 6, "admin_state_str": "ENCHG_STATE_READY", "created_date": 1621354342, "img_load_date": 1621354342, "img_pnum_running": "1.2.2883_release/20.34", "zigbee_dongle_fw_version": "0x1009", "operating": true, "communicating": true, "sleep_enabled": false, "percentFull": 98, "temperature": 25, "maxCellTemp": 26, "comm_level_sub_ghz": 5, "comm_level_2_4_ghz": 5, "led_status": 13, "real_power_w": 216, "dc_switch_off": false, "encharge_rev": 1, "encharge_capacity": 3300}, {"part_num": "830-00703-r67", "installed": 1621354473, "serial_num": "xxx", "device_status": ["envoy.global.ok", "prop.done"], "last_rpt_date": 1621464696, "admin_state": 6, "admin_state_str": "ENCHG_STATE_READY", "created_date": 1621354473, "img_load_date": 1621354473, "img_pnum_running": "1.2.2883_release/20.34", "zigbee_dongle_fw_version": "0x1009", "operating": true, "communicating": true, "sleep_enabled": false, "percentFull": 97, "temperature": 25, "maxCellTemp": 26, "comm_level_sub_ghz": 5, "comm_level_2_4_ghz": 5, "led_status": 13, "real_power_w": 317, "dc_switch_off": false, "encharge_rev": 1, "encharge_capacity": 3300}, {"part_num": "830-00703-r67", "installed": 1621354587, "serial_num": "xxx", "device_status": ["envoy.global.ok", "prop.done"], "last_rpt_date": 1621464802, "admin_state": 6, "admin_state_str": "ENCHG_STATE_READY", "created_date": 1621354587, "img_load_date": 1621354587, "img_pnum_running": "1.2.2883_release/20.34", "zigbee_dongle_fw_version": "0x1009", "operating": true, "communicating": true, "sleep_enabled": false, "percentFull": 97, "temperature": 25, "maxCellTemp": 25, "comm_level_sub_ghz": 5, "comm_level_2_4_ghz": 5, "led_status": 13, "real_power_w": -516, "dc_switch_off": false, "encharge_rev": 1, "encharge_capacity": 3300}]}, {"type": "ENPOWER", "devices": [{"part_num": "860-00276-r28", "installed": 1621354111, "serial_num": "xxx", "device_status": ["envoy.global.ok", "prop.done"], "last_rpt_date": 1621464851, "admin_state": 24, "admin_state_str": "ENPWR_STATE_OPER_CLOSED", "created_date": 1621354111, "img_load_date": 1621354111, "img_pnum_running": "1.2.2064_release/20.34", "zigbee_dongle_fw_version": "0x1009", "operating": true, "communicating": true, "temperature": 79, "comm_level_sub_ghz": 5, "comm_level_2_4_ghz": 5, "mains_admin_state": "closed", "mains_oper_state": "closed", "Enpwr_grid_mode": "multimode-ongrid", "Enchg_grid_mode": "multimode-ongrid", "Enpwr_relay_state_bm": 496, "Enpwr_curr_state_id": 16}]}, {"grid_profile_name": "IEEE 1547 default 2015", "id": "91937832-159a-410a-9594-0a964372e096:0", "grid_profile_version": "1.0.11", "item_count": 2997}]