Endpoint JSON
This section describes the Envoy data used by the library.
Enphase’s installer resource website documents the IQ Gateway local API. As it’s a dynamic resource, use the filters for “Communication Device” and select the Envoy or IQ Gateway types. This example link preselects communication documents. Use the product filters for Envoy and the “Design and Tech Briefs” topic filter.
A wealth of information on the Enphase local Envoy api is available from Matthew1471’s github repository, which is an excellent resource.
The endpoints used by the library are:
# System Production
URL_PRODUCTION_INVERTERS = "/api/v1/production/inverters"
URL_DEVICE_DATA = "/ivp/pdm/device_data"
URL_PRODUCTION_V1 = "/api/v1/production"
URL_PRODUCTION_JSON = "/production.json?details=1"
URL_PRODUCTION = "/production"
# Authentication
URL_AUTH_CHECK_JWT = "/auth/check_jwt"
# Battery and Enpower Status
URL_DRY_CONTACT_STATUS = "/ivp/ensemble/dry_contacts"
URL_DRY_CONTACT_SETTINGS = "/ivp/ss/dry_contact_settings"
URL_ENSEMBLE_INVENTORY = "/ivp/ensemble/inventory"
URL_ENSEMBLE_STATUS = "/ivp/ensemble/status"
URL_ENSEMBLE_SECCTRL = "/ivp/ensemble/secctrl"
URL_ENCHARGE_BATTERY = "/ivp/ensemble/power"
URL_GRID_RELAY = "/ivp/ensemble/relay"
URL_POWER_EXPORT = "/ivp/ss/pel_settings"
URL_TARIFF = "/admin/lib/tariff"
URL_ACB_CONFIG = "/admin/lib/acb_config"
# ?deleted=1 requests that the Envoy include decommissioned devices in the response;
# the updater filters these out by checking admin_state != 0.
URL_INVENTORY = "/inventory.json?deleted=1"
#: Ensemble Generator Configuration endpoint for :any:`EnvoyGeneratorUpdater`
URL_GENERATOR = "/ivp/ensemble/generator"
#: Generator Configuration endpoint for :any:`EnvoyGeneratorUpdater`
URL_GEN_CONFIG = "/ivp/ss/gen_config"
#: Generator mode endpoint for :any:`EnvoyGeneratorUpdater`
URL_GEN_MODE = "/ivp/ss/gen_mode"
#: Generator schedule endpoint for :any:`EnvoyGeneratorUpdater`
URL_GEN_SCHEDULE = "/ivp/ss/gen_schedule"
#: Valid generator modes for :any:`Envoy.set_generator_mode`
GENERATOR_MODES: frozenset[str] = frozenset({"off", "on", "auto"})
#: Settable generator schedule fields for :any:`Envoy.update_generator_schedule`
GENERATOR_SCHEDULE_SETTINGS: frozenset[str] = frozenset(
{
"exercise_freq_in_weeks",
"exercise_day",
"exercise_start",
"exercise_duration",
"default_start_soc",
"default_stop_soc",
}
)
#: Valid exercise days for :any:`Envoy.update_generator_schedule`,
#: in the capitalized short-day-name form the generator firmware reports
GENERATOR_EXERCISE_DAYS: tuple[str, ...] = (
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun",
)
# Meters data
ENDPOINT_URL_METERS = "/ivp/meters"
ENDPOINT_URL_METERS_READINGS = "/ivp/meters/readings"
# Interface configuration
ENDPOINT_URL_HOME = "/home"
#
/info
description
This endpoint is accessible without token authorization and provides information on system serial-number, part-numbers, running packages, firmware version and build date. It returns an xml formatted data set.
xml
<?xml version="1.0" encoding="utf-8"?>
<envoy_info>
<time>1753703630</time>
<device>
<sn>123456789012</sn>
<pn>800-00649-r01</pn>
<software>D8.3.5167</software>
<euaid>4c8675</euaid>
<seqnum>0</seqnum>
<apiver>1</apiver>
<imeter>true</imeter>
</device>
<web-tokens>true</web-tokens>
<package name="agf">
<pn>500-00012-r01</pn>
<version>02.02.00</version>
<build>240195</build>
</package>
<package name="app">
<pn>500-00002-r01</pn>
<version>08.03.5167</version>
<build>5c3a00</build>
</package>
<package name="backbone">
<pn>500-00010-r01</pn>
<version>07.00.20</version>
<build>176d57</build>
</package>
<package name="boot">
<pn>590-00019-r01</pn>
<version>02.00.01</version>
<build>2569cb</build>
</package>
<package name="devimg">
<pn>500-00005-r01</pn>
<version>01.02.536</version>
<build>66b5c8</build>
</package>
<package name="essimg">
<pn>500-00020-r01</pn>
<version>31.43.13</version>
<build>b60ff5</build>
</package>
<package name="ffuimg">
<pn>500-00022-r01</pn>
<version>01.00.04</version>
<build>2cd3479</build>
</package>
<package name="geo">
<pn>500-00008-r01</pn>
<version>02.01.24</version>
<build>a74d96</build>
</package>
<package name="kernel">
<pn>500-00011-r02</pn>
<version>04.04.225</version>
<build>08bedf</build>
</package>
<package name="meter">
<pn>500-00013-r01</pn>
<version>03.02.08</version>
<build>91ea9b</build>
</package>
<package name="patch">
<pn>500-00016-r01</pn>
<version>01.00.00</version>
<build>768</build>
</package>
<package name="pkgsec">
<pn>500-00021-r01</pn>
<version>01.00.00</version>
<build>0fdc14</build>
</package>
<package name="rootfs">
<pn>500-00001-r01</pn>
<version>02.00.00</version>
<build>1211</build>
</package>
<package name="rootfs-full">
<pn>500-00001-r01</pn>
<version>02.00.00</version>
<build>1211</build>
</package>
<package name="security">
<pn>500-00016-r01</pn>
<version>02.00.00</version>
<build>54a6dc</build>
</package>
<build_info>
<build_id>-FRA-799-merge-master-enable-prod:pkg-Jun-03-25-03:50:24</build_id>
<build_time_gmt>1748922970</build_time_gmt>
<release_stage>700-GA</release_stage>
<release_ver>02.00.284</release_ver>
</build_info>
</envoy_info>
/home
description
This endpoint is accessible without token authorization and provides information on configured network interfaces and communication. It is used to retrieve active network device when using interface_settings.
json
{
"software_build_epoch": 1749981828,
"timezone": "US/Eastern",
"current_date": "07/19/2025",
"current_time": "21:25",
"network": {
"web_comm": true,
"ever_reported_to_enlighten": true,
"last_enlighten_report_time": 1752974593,
"primary_interface": "wlan0",
"interfaces": [
{
"signal_strength": 24,
"signal_strength_max": 31,
"network": true,
"type": "cellular",
"interface": "ppp0",
"dhcp": true,
"ip": "1.2.3.4",
"carrier": true
},
{
"type": "ethernet",
"interface": "eth0",
"mac": "01:02:03:04:05:06",
"dhcp": true,
"ip": "192.168.1.100",
"signal_strength": 0,
"signal_strength_max": 1,
"carrier": false
},
{
"signal_strength": 4,
"signal_strength_max": 5,
"type": "wifi",
"interface": "wlan0",
"mac": "02:03:04:05:06:07",
"dhcp": true,
"ip": "192.168.1.101",
"carrier": true,
"supported": true,
"present": true,
"configured": true,
"status": "connected"
}
]
},
"tariff": "time_of_use",
"comm": {
"num": 1,
"level": 0,
"pcu": {
"num": 0,
"level": 0
},
"acb": {
"num": 0,
"level": 0
},
"nsrb": {
"num": 0,
"level": 0
},
"esub": {
"num": 1,
"level": 5
},
"encharge": [
{
"num": 2,
"level": 0,
"level_24g": 0,
"level_subg": 0
}
]
},
"wireless_connection": [
{
"signal_strength": 0,
"signal_strength_max": 0,
"type": "BLE",
"connected": true
}
]
}
/api/v1/production
description
This endpoint is used for production data of a non‑metered Envoy or a metered Envoy without CTs installed. It only contains aggregated phase data. Data is measured/calculated by the Envoy.
Also see Known Issues.
JSON
{
"wattHoursToday": 17645,
"wattHoursSevenDays": 217726,
"wattHoursLifetime": 19229325,
"wattsNow": 5326
}
/api/v1/production/inverters
description
This is the endpoint used for basic inverter production data. If the device_data endpoint is also available, the latter one will be used for inverter data.
JSON
[
{
"serialNumber": "202020202020",
"lastReportDate": 1748576887,
"devType": 1,
"lastReportWatts": 255,
"maxReportWatts": 371
},
{
"serialNumber": "202020202021",
"lastReportDate": 1748576917,
"devType": 1,
"lastReportWatts": 78,
"maxReportWatts": 309
}
]
/inventory.json?deleted=1
description
This endpoint provides details on configured devices used by the Envoy. It is not currently used for data collection, but it is included in fixture_collection() data for background details.
JSON
[
{
"type": "PCU",
"devices": [
{
"part_num": "800-01331-r02",
"installed": "1750786534",
"serial_num": "555555550001",
"device_status": ["envoy.global.ok"],
"last_rpt_date": "1785593319",
"admin_state": 2,
"dev_type": 1,
"created_date": "1750786534",
"img_load_date": "0",
"img_pnum_running": "521-00005-r06-v02.61.01",
"ptpn": "549-00040-r01-v02.61.01",
"chaneid": 1627390225,
"device_control": [
{
"gficlearset": false
}
],
"producing": true,
"communicating": true,
"provisioned": true,
"operating": true,
"phase": "ph-a"
},
{
"part_num": "800-01331-r02",
"installed": "1750786537",
"serial_num": "555555550002",
"device_status": ["envoy.global.ok"],
"last_rpt_date": "1785593227",
"admin_state": 2,
"dev_type": 1,
"created_date": "1750786537",
"img_load_date": "0",
"img_pnum_running": "521-00005-r06-v02.61.01",
"ptpn": "549-00040-r01-v02.61.01",
"chaneid": 1627390481,
"device_control": [
{
"gficlearset": false
}
],
"producing": true,
"communicating": true,
"provisioned": true,
"operating": true,
"phase": "ph-a"
}
]
},
{
"type": "ACB",
"devices": []
},
{
"type": "NSRB",
"devices": []
},
{
"type": "ESUB",
"devices": [
{
"part_num": "800-01855-r01",
"installed": "1750786738",
"serial_num": "202020200001",
"device_status": ["envoy.global.ok"],
"last_rpt_date": "1785593318",
"admin_state": 1,
"dev_type": 19,
"created_date": "1750786738",
"img_load_date": "0",
"img_pnum_running": "523-00001-r01-v01.18.00",
"ptpn": "551-00064-r01-v01.18.00",
"chaneid": 1929380113,
"device_control": [
{
"gficlearset": false
}
],
"producing": false,
"communicating": true,
"operating": true
}
]
}
]
/ivp/ensemble/inventory
description
This is the endpoint with the inventory of Ensemble devices.
JSON
[
{
"type": "ENCHARGE",
"devices": [
{
"part_num": "836-01250-r00",
"serial_num": "202020200001",
"installed": 1752939764,
"device_status": ["envoy.global.ok", "prop.done"],
"last_rpt_date": 1752974610,
"admin_state": 63,
"admin_state_str": "ENCMN_MDE_ENCHARGE_READY",
"created_date": 1752939764,
"img_load_date": 1752939764,
"img_pnum_running": "4.5.35",
"bmu_fw_version": "4.5.35",
"communicating": true,
"sleep_enabled": false,
"percentFull": 92,
"temperature": 32,
"maxCellTemp": 33,
"reported_enc_grid_state": "grid-tied",
"comm_level_sub_ghz": 0,
"comm_level_2_4_ghz": 0,
"led_status": 12,
"dc_switch_off": false,
"encharge_rev": 4,
"encharge_capacity": 5000,
"phase": "ph-a",
"der_index": 2
},
{
"part_num": "836-01250-r00",
"serial_num": "202020200002",
"installed": 1752939763,
"device_status": ["envoy.global.ok", "prop.done"],
"last_rpt_date": 1752974529,
"admin_state": 63,
"admin_state_str": "ENCMN_MDE_ENCHARGE_READY",
"created_date": 1752939763,
"img_load_date": 1752939763,
"img_pnum_running": "4.5.35",
"bmu_fw_version": "4.5.35",
"communicating": true,
"sleep_enabled": false,
"percentFull": 86,
"temperature": 33,
"maxCellTemp": 33,
"reported_enc_grid_state": "grid-tied",
"comm_level_sub_ghz": 0,
"comm_level_2_4_ghz": 0,
"led_status": 12,
"dc_switch_off": false,
"encharge_rev": 4,
"encharge_capacity": 5000,
"phase": "ph-a",
"der_index": 2
}
]
},
{
"type": "COLLAR",
"devices": [
{
"part_num": "865-00400-r22",
"serial_num": "212121210001",
"installed": 1752939759,
"device_status": ["envoy.global.ok", "prop.done"],
"last_rpt_date": 1752939759,
"admin_state": 88,
"admin_state_str": "ENCMN_MDE_ON_GRID",
"created_date": 1752939759,
"img_load_date": 1752939759,
"img_pnum_running": "3.0.6-D0",
"communicating": true,
"temperature": 42,
"mid_state": "close",
"grid_state": "on_grid",
"control_error": 0,
"collar_state": "Installed"
}
]
},
{
"type": "C6 COMBINER CONTROLLER",
"devices": [
{
"part_num": "800-02403-r08",
"serial_num": "222222220001",
"installed": 1752945451,
"last_rpt_date": 1752945451,
"admin_state": 82,
"admin_state_str": "ENCMN_C6_CC_READY",
"created_date": 1752945451,
"img_load_date": 1752945451,
"fw_version": "0.1.20-D1",
"dmir_version": "0.1.20-D1",
"communicating": true
}
]
},
{
"type": "C6 RGM",
"devices": [
{
"part_num": "800-02403-r08",
"serial_num": "232323230001",
"installed": 1752939759,
"FW Version": "2.2.1-D4119",
"Device State": 80
}
]
}
]
/ivp/ensemble/power
description
This is the endpoint with actual power data of Ensemble batteries.
JSON
{
"devices:": [
{
"serial_num": "492122230001",
"real_power_mw": -532000,
"apparent_power_mva": -532000,
"soc": 92
},
{
"serial_num": "492122230002",
"real_power_mw": -552000,
"apparent_power_mva": -552000,
"soc": 86
}
]
}
/ivp/ensemble/status
description
This is the endpoint with the installation status of Ensemble devices.
JSON
{
"inventory": {
"serial_nums": {
"484848480001": {
"device_type": 27,
"com_interface_str": "CAN",
"device_id": "484848480001",
"admin_state": 88,
"admin_state_str": "ENCMN_MDE_ON_GRID",
"prop_set": true,
"installed": 1,
"msg_retry_count": 0,
"part_number": "865-00400-r22",
"assembly_number": "885-00400-r23",
"app_fw_version": "3.0.6-D0",
"ibl_fw_version": "",
"swift_asic_fw_version": "",
"bmu_fw_version": "",
"dmir": {
"part_number": "",
"assembly_number": ""
},
"procload": {
"part_number": "000-00000-r00",
"assembly_number": "3.0.6-D0"
},
"submodule_count": 0,
"submodules": {}
},
"484848480002": {
"device_type": 30,
"com_interface_str": "USB",
"device_id": "484848480002",
"admin_state": 43,
"admin_state_str": "ENS_DEVICE_STATE_READY",
"prop_set": true,
"msg_retry_count": 0,
"part_number": "865-00600-r03",
"assembly_number": "885-00600-r03",
"app_fw_version": "4.0.1107_rel/99.19",
"ibl_fw_version": "1.3.413",
"swift_asic_fw_version": "",
"bmu_fw_version": "",
"dmir": {
"part_number": "546-00003-01",
"assembly_number": "01"
},
"procload": {
"part_number": "522-00003-01",
"assembly_number": "4.0.1107_rel/99.19"
},
"submodule_count": 1,
"submodules": {
"484848480003": {
"device_type": 31,
"admin_state": 1,
"part_number": "800-02403-r08",
"assembly_number": "830-02403-r03",
"dmir": {
"part_number": "546-00003-01",
"assembly_number": "01"
},
"procload": {
"part_number": "522-00004-01",
"assembly_number": "4.0.1107_rel/99.19"
}
}
}
},
"484848480004": {
"device_type": 125,
"com_interface_str": "CAN",
"device_id": "484848480004",
"admin_state": 82,
"admin_state_str": "ENCMN_C6_CC_READY",
"prop_set": true,
"msg_retry_count": 0,
"part_number": "800-02403-r08",
"assembly_number": "800-02403-r01",
"app_fw_version": "0.1.20-D1",
"ibl_fw_version": "",
"swift_asic_fw_version": "",
"bmu_fw_version": "",
"dmir": {
"part_number": "546-00060-r00",
"assembly_number": "0.1.20-D1"
},
"procload": {
"part_number": "522-00060-r00",
"assembly_number": "0.1.20-D1"
},
"submodule_count": 0,
"submodules": {}
},
"484848480005": {
"device_type": 115,
"com_interface_str": "CAN",
"device_id": "484848480005",
"admin_state": 80,
"admin_state_str": "ENCMN_C6_RGM_DEV_CONNECTED",
"prop_set": true,
"msg_retry_count": 0,
"part_number": "800-02403-r08",
"assembly_number": "880-01407-r05",
"app_fw_version": "2.2.1-D4119",
"ibl_fw_version": "",
"swift_asic_fw_version": "",
"bmu_fw_version": "",
"dmir": {
"part_number": "",
"assembly_number": ""
},
"procload": {
"part_number": "521-00015-r00",
"assembly_number": "2.2.1-D4119"
},
"submodule_count": 0,
"submodules": {}
},
"484848480006": {
"device_type": 13,
"com_interface_str": "CAN",
"device_id": "484848480006",
"admin_state": 63,
"admin_state_str": "ENCMN_MDE_ENCHARGE_READY",
"prop_set": true,
"reported_grid_mode": "multimode-ongrid",
"phase": "ph-a",
"der_index": 2,
"encharge_revision": 4,
"encharge_capacity": 5000,
"encharge_rated_power": 3540,
"reported_enc_grid_state": "multimode-ongrid",
"msg_retry_count": 0,
"part_number": "836-01250-r00",
"assembly_number": "836-01250-r00",
"app_fw_version": "4.5.35",
"ibl_fw_version": "",
"swift_asic_fw_version": "",
"bmu_fw_version": "4.5.35",
"dmir": {
"part_number": "",
"assembly_number": ""
},
"procload": {
"part_number": "",
"assembly_number": ""
},
"submodule_count": 4,
"submodules": {
"484848480007": {
"device_type": 14,
"alternate_device_type": 120,
"fsm_state": "ENCMN_MDE_PCU_READY",
"admin_state": 1,
"part_number": "800-02041-r05",
"assembly_number": "892-10301-r11",
"rated_power": 2100,
"is_ll": true,
"pcu_phase": "ph-b",
"dmir": {
"part_number": "549-00076-r00",
"assembly_number": "10.9.63-D14494"
},
"procload": {
"part_number": "521-00012-r00",
"assembly_number": "10.9.63-D14494"
}
},
"484848480008": {
"device_type": 16,
"alternate_device_type": 100,
"fsm_state": "ENCMN_MDE_BMU_READY",
"admin_state": 1,
"part_number": "836-11350-r11",
"assembly_number": "892-10301-r11",
"dmir": {
"part_number": "000-00000-r00",
"assembly_number": "0.0.0-D0"
},
"procload": {
"part_number": "522-00040-r00",
"assembly_number": "4.5.35-D1"
}
},
"484848480009": {
"device_type": 14,
"alternate_device_type": 120,
"fsm_state": "ENCMN_MDE_PCU_READY",
"admin_state": 1,
"part_number": "800-02042-r05",
"assembly_number": "892-10301-r11",
"rated_power": 1440,
"is_ll": false,
"pcu_phase": "ph-b",
"dmir": {
"part_number": "549-00095-r00",
"assembly_number": "10.9.64-D14561"
},
"procload": {
"part_number": "521-00016-r00",
"assembly_number": "10.9.64-D14561"
}
},
"484848480010": {
"device_type": 16,
"alternate_device_type": 100,
"fsm_state": "ENCMN_MDE_BMU_READY",
"admin_state": 1,
"part_number": "836-11350-r11",
"assembly_number": "892-10301-r11",
"dmir": {
"part_number": "000-00000-r00",
"assembly_number": "0.0.0-D0"
},
"procload": {
"part_number": "522-00040-r00",
"assembly_number": "4.5.35-D1"
}
}
}
},
"484848480011": {
"device_type": 13,
"com_interface_str": "CAN",
"device_id": "484848480011",
"admin_state": 63,
"admin_state_str": "ENCMN_MDE_ENCHARGE_READY",
"prop_set": true,
"reported_grid_mode": "multimode-ongrid",
"phase": "ph-a",
"der_index": 2,
"encharge_revision": 4,
"encharge_capacity": 5000,
"encharge_rated_power": 3540,
"reported_enc_grid_state": "multimode-ongrid",
"msg_retry_count": 1,
"part_number": "836-01250-r00",
"assembly_number": "836-01250-r00",
"app_fw_version": "4.5.35",
"ibl_fw_version": "",
"swift_asic_fw_version": "",
"bmu_fw_version": "4.5.35",
"dmir": {
"part_number": "",
"assembly_number": ""
},
"procload": {
"part_number": "",
"assembly_number": ""
},
"submodule_count": 4,
"submodules": {
"484848480012": {
"device_type": 14,
"alternate_device_type": 120,
"fsm_state": "ENCMN_MDE_PCU_READY",
"admin_state": 1,
"part_number": "800-02041-r05",
"assembly_number": "892-10301-r11",
"rated_power": 2100,
"is_ll": true,
"pcu_phase": "ph-a",
"dmir": {
"part_number": "549-00076-r00",
"assembly_number": "10.9.63-D14494"
},
"procload": {
"part_number": "521-00012-r00",
"assembly_number": "10.9.63-D14494"
}
},
"484848480013": {
"device_type": 16,
"alternate_device_type": 100,
"fsm_state": "ENCMN_MDE_BMU_READY",
"admin_state": 1,
"part_number": "836-11350-r11",
"assembly_number": "892-10301-r11",
"dmir": {
"part_number": "000-00000-r00",
"assembly_number": "0.0.0-D0"
},
"procload": {
"part_number": "522-00040-r00",
"assembly_number": "4.5.35-D1"
}
},
"484848480014": {
"device_type": 14,
"alternate_device_type": 120,
"fsm_state": "ENCMN_MDE_PCU_READY",
"admin_state": 1,
"part_number": "800-02042-r05",
"assembly_number": "892-10301-r11",
"rated_power": 1440,
"is_ll": false,
"pcu_phase": "ph-a",
"dmir": {
"part_number": "549-00095-r00",
"assembly_number": "10.9.64-D14561"
},
"procload": {
"part_number": "521-00016-r00",
"assembly_number": "10.9.64-D14561"
}
},
"484848480015": {
"device_type": 16,
"alternate_device_type": 100,
"fsm_state": "ENCMN_MDE_BMU_READY",
"admin_state": 1,
"part_number": "836-11350-r11",
"assembly_number": "892-10301-r11",
"dmir": {
"part_number": "000-00000-r00",
"assembly_number": "0.0.0-D0"
},
"procload": {
"part_number": "522-00040-r00",
"assembly_number": "4.5.35-D1"
}
}
}
}
}
},
"secctrl": {
"shutdown": false,
"freq_bias_hz": 0.0,
"voltage_bias_v": 0.0,
"freq_bias_hz_q8": 0,
"voltage_bias_v_q5": 0,
"freq_bias_hz_phaseb": 0.0,
"voltage_bias_v_phaseb": 0.0,
"freq_bias_hz_q8_phaseb": 0,
"voltage_bias_v_q5_phaseb": 0,
"freq_bias_hz_phasec": 0.0,
"voltage_bias_v_phasec": 0.0,
"freq_bias_hz_q8_phasec": 0,
"voltage_bias_v_q5_phasec": 0,
"offgrid_secctrl": {
"F": 0.7687389826090736,
"V": -0.0014091715353808515,
"Vd_neg": 5.126506875393791,
"Vq_neg": 1.5839945028613174,
"Vd_zero": 0.8743872414038012,
"Vq_zero": 5.888518297886519,
"is_active": false,
"is_system_balanced": false
},
"configured_backup_soc": 100,
"adjusted_backup_soc": 100,
"agg_soc": 89,
"Max_energy": 10000,
"ENC_agg_soc": 89,
"ENC_agg_soh": 100,
"ENC_agg_backup_energy": 10000,
"ENC_agg_avail_energy": 8900,
"Enc_commissioned_capacity": 10000,
"Enc_max_available_capacity": 10000,
"ACB_agg_soc": 0,
"ACB_agg_energy": 0,
"VLS_Limit": 5,
"soc_rec_enabled": true,
"soc_recovery_entry": 0,
"soc_recovery_exit": 10,
"Commission_in_progress": false,
"ESS_in_progress": false,
"ESS_R3_To_R4_in_progress": false
},
"relay": {
"mains_admin_state": "closed",
"mains_oper_state": "closed",
"srt12_state": "open",
"srt13_state": "open",
"der1_state": 1,
"der2_state": 1,
"der3_state": 1,
"Enchg_grid_mode": "multimode-ongrid",
"Solar_grid_mode": "multimode-ongrid"
}
}
/ivp/meters
description
This is the endpoint used for installed CT meters configuration.
JSON
[
{
"eid": 704643328,
"state": "enabled",
"measurementType": "production",
"phaseMode": "split",
"phaseCount": 2,
"meteringStatus": "normal",
"statusFlags": []
},
{
"eid": 704643584,
"state": "enabled",
"measurementType": "net-consumption",
"phaseMode": "split",
"phaseCount": 2,
"meteringStatus": "normal",
"statusFlags": []
},
{
"eid": 704643840,
"state": "enabled",
"measurementType": "storage",
"phaseMode": "split",
"phaseCount": 2,
"meteringStatus": "normal",
"statusFlags": []
}
]
/ivp/meters/readings
description
This is the endpoint used for CT meter readings.
JSON
[
{
"eid": 704643328,
"timestamp": 1722967007,
"actEnergyDlvd": 13431336.968,
"actEnergyRcvd": 164.852,
"apparentEnergy": 17695037.667,
"reactEnergyLagg": 2870787.07,
"reactEnergyLead": 197885.914,
"instantaneousDemand": 7131.017,
"activePower": 7131.017,
"apparentPower": 7237.365,
"reactivePower": -3.719,
"pwrFactor": 0.985,
"voltage": 247.307,
"current": 58.537,
"freq": 60.0,
"channels": [
{
"eid": 1778385169,
"timestamp": 1722967007,
"actEnergyDlvd": 6709437.261,
"actEnergyRcvd": 92.996,
"apparentEnergy": 8841528.936,
"reactEnergyLagg": 1433208.527,
"reactEnergyLead": 100991.799,
"instantaneousDemand": 3562.174,
"activePower": 3562.174,
"apparentPower": 3615.485,
"reactivePower": 2.24,
"pwrFactor": 0.984,
"voltage": 123.571,
"current": 29.262,
"freq": 60.0
},
{
"eid": 1778385170,
"timestamp": 1722967007,
"actEnergyDlvd": 6721899.707,
"actEnergyRcvd": 71.856,
"apparentEnergy": 8853508.731,
"reactEnergyLagg": 1437578.543,
"reactEnergyLead": 96894.114,
"instantaneousDemand": 3568.843,
"activePower": 3568.843,
"apparentPower": 3621.88,
"reactivePower": -5.959,
"pwrFactor": 0.986,
"voltage": 123.736,
"current": 29.276,
"freq": 60.0
},
{
"eid": 1778385171,
"timestamp": 1722967007,
"actEnergyDlvd": 0.0,
"actEnergyRcvd": 0.0,
"apparentEnergy": 0.0,
"reactEnergyLagg": 0.0,
"reactEnergyLead": 0.0,
"instantaneousDemand": 0.0,
"activePower": 0.0,
"apparentPower": 0.0,
"reactivePower": 0.0,
"pwrFactor": 0.0,
"voltage": 0.0,
"current": 0.0,
"freq": 60.0
}
]
},
{
"eid": 704643584,
"timestamp": 1722967007,
"actEnergyDlvd": 5855939.23,
"actEnergyRcvd": 4173334.272,
"apparentEnergy": 25731843.679,
"reactEnergyLagg": 13884.226,
"reactEnergyLead": 18899511.617,
"instantaneousDemand": 1749.504,
"activePower": 1749.504,
"apparentPower": 2826.5,
"reactivePower": -1381.858,
"pwrFactor": 0.618,
"voltage": 247.172,
"current": 22.923,
"freq": 60.0,
"channels": [
{
"eid": 1778385425,
"timestamp": 1722967007,
"actEnergyDlvd": 2817654.26,
"actEnergyRcvd": 2329054.288,
"apparentEnergy": 12904982.372,
"reactEnergyLagg": 8801.054,
"reactEnergyLead": 9410020.986,
"instantaneousDemand": 809.907,
"activePower": 809.907,
"apparentPower": 1438.017,
"reactivePower": -851.171,
"pwrFactor": 0.563,
"voltage": 123.482,
"current": 11.642,
"freq": 60.0
},
{
"eid": 1778385426,
"timestamp": 1722967007,
"actEnergyDlvd": 3038284.97,
"actEnergyRcvd": 1844279.984,
"apparentEnergy": 12826861.306,
"reactEnergyLagg": 5083.172,
"reactEnergyLead": 9489490.631,
"instantaneousDemand": 939.597,
"activePower": 939.597,
"apparentPower": 1388.484,
"reactivePower": -530.687,
"pwrFactor": 0.674,
"voltage": 123.69,
"current": 11.281,
"freq": 60.0
},
{
"eid": 1778385427,
"timestamp": 1722967007,
"actEnergyDlvd": 2037731.459,
"actEnergyRcvd": 2706201.405,
"apparentEnergy": 7469208.32,
"reactEnergyLagg": 3071742.732,
"reactEnergyLead": 73803.42,
"instantaneousDemand": -3545.209,
"activePower": -3545.209,
"apparentPower": 3563.706,
"reactivePower": 22.091,
"pwrFactor": -0.994,
"voltage": 123.696,
"current": 28.813,
"freq": 60.0
}
]
},
{
"eid": 704643840,
"timestamp": 1722967007,
"actEnergyDlvd": 4073871.031,
"actEnergyRcvd": 5409935.465,
"apparentEnergy": 14939666.293,
"reactEnergyLagg": 6143996.517,
"reactEnergyLead": 147616.472,
"instantaneousDemand": -7083.656,
"activePower": -7083.656,
"apparentPower": 7210.614,
"reactivePower": 49.385,
"pwrFactor": -0.962,
"voltage": 247.392,
"current": 57.627,
"freq": 60.0,
"channels": [
{
"eid": 1778385681,
"timestamp": 1722967007,
"actEnergyDlvd": 2036139.572,
"actEnergyRcvd": 2703734.06,
"apparentEnergy": 7470457.973,
"reactEnergyLagg": 3072253.785,
"reactEnergyLead": 73813.053,
"instantaneousDemand": -3538.447,
"activePower": -3538.447,
"apparentPower": 3646.908,
"reactivePower": 27.294,
"pwrFactor": -0.994,
"voltage": 123.696,
"current": 28.813,
"freq": 60.0
},
{
"eid": 1778385682,
"timestamp": 1722967007,
"actEnergyDlvd": 2037731.459,
"actEnergyRcvd": 2706201.405,
"apparentEnergy": 7469208.32,
"reactEnergyLagg": 3071742.732,
"reactEnergyLead": 73803.42,
"instantaneousDemand": -3545.209,
"activePower": -3545.209,
"apparentPower": 3563.706,
"reactivePower": 22.091,
"pwrFactor": -0.994,
"voltage": 123.696,
"current": 28.813,
"freq": 60.0
},
{
"eid": 1778385683,
"timestamp": 1722967007,
"actEnergyDlvd": 0.0,
"actEnergyRcvd": 0.0,
"apparentEnergy": 0.0,
"reactEnergyLagg": 0.0,
"reactEnergyLead": 0.0,
"instantaneousDemand": 0.0,
"activePower": 0.0,
"apparentPower": 0.0,
"reactivePower": 0.0,
"pwrFactor": 0.0,
"voltage": 0.0,
"current": 0.0,
"freq": 0.0
}
]
}
]
/ivp/pdm/device_data
description
This is the endpoint used for detailed inverter data. If this endpoint is available, it will be used for inverter data instead of the inverter endpoint
Also see Known Issues.
JSON
{
"553648384": {
"devName": "pcu",
"sn": "202020202020",
"active": true,
"modGone": false,
"channels": [
{
"chanEid": 1627390225,
"created": 1748576887,
"wattHours": {
"today": 1239,
"yesterday": 455,
"week": 7466
},
"watts": {
"now": 255,
"nowUsed": 0,
"max": 371
},
"lastReading": {
"eid": 1627390225,
"interval_type": 0,
"endDate": 1748576887,
"duration": 903,
"flags": 0,
"flags_hex": "0x0000000000000000",
"joulesProduced": 230400,
"acVoltageINmV": 248156,
"acFrequencyINmHz": 50013,
"dcVoltageINmV": 32363,
"dcCurrentINmA": 8078,
"channelTemp": 38,
"pwrConvErrSecs": 0,
"pwrConvMaxErrCycles": 0,
"joulesUsed": 0,
"leadingVArs": 0,
"laggingVArs": 38,
"acCurrentInmA": 1049,
"l1NAcVoltageInmV": 0,
"l2NAcVoltageInmV": 0,
"l3NAcVoltageInmV": 0,
"rssi": 110,
"issi": 68
},
"lifetime": {
"createdTime": 1744834453,
"duration": 6124463,
"joulesProduced": 354281850
}
}
]
},
"553648640": {
"devName": "pcu",
"sn": "202020202021",
"active": true,
"modGone": false,
"channels": [
{
"chanEid": 1627390481,
"created": 1748576917,
"wattHours": {
"today": 773,
"yesterday": 447,
"week": 5129
},
"watts": {
"now": 78,
"nowUsed": 0,
"max": 309
},
"lastReading": {
"eid": 1627390481,
"interval_type": 0,
"endDate": 1748576917,
"duration": 903,
"flags": 0,
"flags_hex": "0x0000000000000000",
"joulesProduced": 70425,
"acVoltageINmV": 246188,
"acFrequencyINmHz": 50019,
"dcVoltageINmV": 31684,
"dcCurrentINmA": 2324,
"channelTemp": 30,
"pwrConvErrSecs": 0,
"pwrConvMaxErrCycles": 0,
"joulesUsed": 0,
"leadingVArs": 1,
"laggingVArs": 39,
"acCurrentInmA": 435,
"l1NAcVoltageInmV": 0,
"l2NAcVoltageInmV": 0,
"l3NAcVoltageInmV": 0,
"rssi": 110,
"issi": 70
},
"lifetime": {
"createdTime": 1744834377,
"duration": 6125538,
"joulesProduced": 259647525
}
}
]
},
"deviceCount": 2,
"deviceDataLimit": 50
}
/production.json?details=1
description
This is the default endpoint for production and consumption data. It contains data for aggregated and individual phases. Data is measured/calculated by the Envoy. Individual phase data is in the lines segment.
For non-metered Envoy, the
type: "eim"sections are not present.For Envoy-metered without a production CT:
the
productionitem wheretype == "eim"andmeasurementType == "production"hasactiveCount == 0.
For Envoy-metered with:
a net-consumption CT, the total-consumption data is calculated by the Envoy.
a total-consumption CT, the net-consumption data is calculated by the Envoy.
For Envoy-metered without any consumption CT:
the
consumptionitem wheretype == "eim"andmeasurementType == "net-consumption"hasactiveCount == 0;the
consumptionitem wheretype == "eim"andmeasurementType == "total-consumption"hasactiveCount == 0.
Also see Known Issues.
JSON
{
"production": [
{
"type": "inverters",
"activeCount": 12,
"readingTime": 1753703609,
"wNow": 3554,
"whLifetime": 390554
},
{
"type": "eim",
"activeCount": 1,
"measurementType": "production",
"readingTime": 1753703631,
"wNow": 5305.189,
"whLifetime": 569121.609,
"varhLeadLifetime": 654.214,
"varhLagLifetime": 111284.568,
"vahLifetime": 639677.045,
"rmsCurrent": 22.387,
"rmsVoltage": 694.538,
"reactPwr": 66.542,
"apprntPwr": 5312.124,
"pwrFactor": 1.0,
"whToday": 19282.609,
"whLastSevenDays": 550554.609,
"vahToday": 20975.045,
"varhLeadToday": 31.214,
"varhLagToday": 2653.568,
"lines": [
{
"wNow": 2968.936,
"whLifetime": 308602.766,
"varhLeadLifetime": 0.001,
"varhLagLifetime": 74358.312,
"vahLifetime": 347513.175,
"rmsCurrent": 12.248,
"rmsVoltage": 237.874,
"reactPwr": 76.271,
"apprntPwr": 2975.208,
"pwrFactor": 1.0,
"whToday": 10031.766,
"whLastSevenDays": 298976.766,
"vahToday": 10942.175,
"varhLeadToday": 0.001,
"varhLagToday": 1745.312
},
{
"wNow": 1169.938,
"whLifetime": 130643.441,
"varhLeadLifetime": 398.18,
"varhLagLifetime": 18422.28,
"vahLifetime": 150350.305,
"rmsCurrent": 5.048,
"rmsVoltage": 229.76,
"reactPwr": -6.075,
"apprntPwr": 1170.359,
"pwrFactor": 1.0,
"whToday": 4640.441,
"whLastSevenDays": 126158.441,
"vahToday": 5122.305,
"varhLeadToday": 19.18,
"varhLagToday": 451.28
},
{
"wNow": 1166.315,
"whLifetime": 129875.403,
"varhLeadLifetime": 256.033,
"varhLagLifetime": 18503.976,
"vahLifetime": 141813.564,
"rmsCurrent": 5.09,
"rmsVoltage": 226.904,
"reactPwr": -3.654,
"apprntPwr": 1166.557,
"pwrFactor": 1.0,
"whToday": 4610.403,
"whLastSevenDays": 125419.403,
"vahToday": 4910.564,
"varhLeadToday": 12.033,
"varhLagToday": 456.976
}
]
}
],
"consumption": [
{
"type": "eim",
"activeCount": 1,
"measurementType": "total-consumption",
"readingTime": 1753703631,
"wNow": 324.922,
"whLifetime": 253002.232,
"varhLeadLifetime": 348504.505,
"varhLagLifetime": -103510.423,
"vahLifetime": 785760.378,
"rmsCurrent": 0.999,
"rmsVoltage": 694.597,
"reactPwr": -814.961,
"apprntPwr": 229.496,
"pwrFactor": 1.0,
"whToday": 8958.0,
"whLastSevenDays": 0.0,
"vahToday": 22634.378,
"varhLeadToday": 323620.505,
"varhLagToday": 0.0,
"lines": [
{
"wNow": 36.232,
"whLifetime": 72206.813,
"varhLeadLifetime": 192956.107,
"varhLagLifetime": -74353.869,
"vahLifetime": 391039.531,
"rmsCurrent": -0.015,
"rmsVoltage": 237.835,
"reactPwr": -427.819,
"apprntPwr": -3.635,
"pwrFactor": 1.0,
"whToday": 2334.813,
"whLastSevenDays": 6.813,
"vahToday": 11270.531,
"varhLeadToday": 4693.107,
"varhLagToday": 0.0
},
{
"wNow": 283.682,
"whLifetime": 143898.912,
"varhLeadLifetime": 101343.058,
"varhLagLifetime": -18375.429,
"vahLifetime": 202341.602,
"rmsCurrent": 1.033,
"rmsVoltage": 229.824,
"reactPwr": -281.655,
"apprntPwr": 237.474,
"pwrFactor": 1.0,
"whToday": 5158.912,
"whLastSevenDays": 42.912,
"vahToday": 5963.602,
"varhLeadToday": 2580.058,
"varhLagToday": 0.0
},
{
"wNow": 5.009,
"whLifetime": 36896.507,
"varhLeadLifetime": 54205.34,
"varhLagLifetime": -10781.125,
"vahLifetime": 192379.245,
"rmsCurrent": -0.019,
"rmsVoltage": 226.938,
"reactPwr": -105.486,
"apprntPwr": -4.342,
"pwrFactor": 1.0,
"whToday": 1515.507,
"whLastSevenDays": 1.507,
"vahToday": 5400.245,
"varhLeadToday": 1269.34,
"varhLagToday": 0.0
}
]
},
{
"type": "eim",
"activeCount": 1,
"measurementType": "net-consumption",
"readingTime": 1753703631,
"wNow": -4980.266,
"whLifetime": -315944.246,
"varhLeadLifetime": 349158.719,
"varhLagLifetime": 7774.145,
"vahLifetime": 785760.378,
"rmsCurrent": -21.388,
"rmsVoltage": 694.597,
"reactPwr": -881.503,
"apprntPwr": -4998.912,
"pwrFactor": -1.0,
"whToday": 0,
"whLastSevenDays": 0,
"vahToday": 0,
"varhLeadToday": 0,
"varhLagToday": 0,
"lines": [
{
"wNow": -2932.704,
"whLifetime": -236343.094,
"varhLeadLifetime": 192956.108,
"varhLagLifetime": 4.443,
"vahLifetime": 391039.531,
"rmsCurrent": -12.263,
"rmsVoltage": 237.835,
"reactPwr": -504.09,
"apprntPwr": -2916.631,
"pwrFactor": -1.0,
"whToday": 0,
"whLastSevenDays": 0,
"vahToday": 0,
"varhLeadToday": 0,
"varhLagToday": 0
},
{
"wNow": -886.257,
"whLifetime": 13341.32,
"varhLeadLifetime": 101741.238,
"varhLagLifetime": 46.852,
"vahLifetime": 202341.602,
"rmsCurrent": -4.015,
"rmsVoltage": 229.824,
"reactPwr": -275.58,
"apprntPwr": -922.725,
"pwrFactor": -1.0,
"whToday": 0,
"whLastSevenDays": 0,
"vahToday": 0,
"varhLeadToday": 0,
"varhLagToday": 0
},
{
"wNow": -1161.306,
"whLifetime": -92942.472,
"varhLeadLifetime": 54461.373,
"varhLagLifetime": 7722.85,
"vahLifetime": 192379.245,
"rmsCurrent": -5.11,
"rmsVoltage": 226.938,
"reactPwr": -101.832,
"apprntPwr": -1159.556,
"pwrFactor": -1.0,
"whToday": 0,
"whLastSevenDays": 0,
"vahToday": 0,
"varhLeadToday": 0,
"varhLagToday": 0
}
]
}
],
"storage": [
{
"type": "acb",
"activeCount": 0,
"readingTime": 0,
"wNow": 0,
"whNow": 0,
"state": "idle"
}
]
}
/production
description
This is an endpoint for production and consumption data used when older firmware is running in the Envoy and the standard endpoint is not providing data. It only contains data for aggregated phases, no individual phase data is available. Data is measured/calculated by the Envoy.
For non-metered Envoy, the
type: "eim"sections are not present.For Envoy-metered without a production CT:
the
productionitem wheretype == "eim"andmeasurementType == "production"hasactiveCount == 0.
For Envoy-metered with:
a net-consumption CT, the total-consumption data is calculated by the Envoy.
a total-consumption CT, the net-consumption data is calculated by the Envoy.
For Envoy-metered without any consumption CT:
the
consumptionitem wheretype == "eim"andmeasurementType == "net-consumption"hasactiveCount == 0;the
consumptionitem wheretype == "eim"andmeasurementType == "total-consumption"hasactiveCount == 0.
Known issues
Also see Known Issues.
JSON
{
"production": [
{
"type": "inverters",
"activeCount": 12,
"readingTime": 1753703609,
"wNow": 3554,
"whLifetime": 390554
},
{
"type": "eim",
"activeCount": 1,
"measurementType": "production",
"readingTime": 1753703631,
"wNow": 5305.189,
"whLifetime": 569121.609,
"varhLeadLifetime": 654.214,
"varhLagLifetime": 111284.568,
"vahLifetime": 639677.045,
"rmsCurrent": 22.387,
"rmsVoltage": 694.538,
"reactPwr": 66.542,
"apprntPwr": 5312.124,
"pwrFactor": 1.0,
"whToday": 19282.609,
"whLastSevenDays": 550554.609,
"vahToday": 20975.045,
"varhLeadToday": 31.214,
"varhLagToday": 2653.568
}
],
"consumption": [
{
"type": "eim",
"activeCount": 1,
"measurementType": "total-consumption",
"readingTime": 1753703631,
"wNow": 324.922,
"whLifetime": 253002.232,
"varhLeadLifetime": 348504.505,
"varhLagLifetime": -103510.423,
"vahLifetime": 785760.378,
"rmsCurrent": 0.999,
"rmsVoltage": 694.597,
"reactPwr": -814.961,
"apprntPwr": 229.496,
"pwrFactor": 1.0,
"whToday": 8958.0,
"whLastSevenDays": 0.0,
"vahToday": 22634.378,
"varhLeadToday": 323620.505,
"varhLagToday": 0.0
},
{
"type": "eim",
"activeCount": 1,
"measurementType": "net-consumption",
"readingTime": 1753703631,
"wNow": -4980.266,
"whLifetime": -315944.246,
"varhLeadLifetime": 349158.719,
"varhLagLifetime": 7774.145,
"vahLifetime": 785760.378,
"rmsCurrent": -21.388,
"rmsVoltage": 694.597,
"reactPwr": -881.503,
"apprntPwr": -4998.912,
"pwrFactor": -1.0,
"whToday": 0,
"whLastSevenDays": 0,
"vahToday": 0,
"varhLeadToday": 0,
"varhLagToday": 0
}
],
"storage": [
{
"type": "acb",
"activeCount": 0,
"readingTime": 0,
"wNow": 0,
"whNow": 0,
"state": "idle"
}
]
}