Endpoint JSON
This section describes the Envoy data used by the library.
Enphase’s installer resource website documents the IQ Gateway local API. Because it’s a dynamic resource, use the filters for “Communication Device” and select the Envoy or IQ Gateway types. This example link pre-selects 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.
/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.
JSON
[
{
"serialNumber": "202020202020",
"lastReportDate": 1748576887,
"devType": 1,
"lastReportWatts": 255,
"maxReportWatts": 371
},
{
"serialNumber": "202020202021",
"lastReportDate": 1748576917,
"devType": 1,
"lastReportWatts": 78,
"maxReportWatts": 309
}
]
/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.
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"
}
]
}