Consumption.adoc

IVP - Meters - Reports - Consumption Only

Get readings from the consumption meters.

Table of Contents

• Introduction
• Request
• Response
  • Root
  • MeterReading Object
• Types
  • MeasurementType Type
• Examples
  • Get Consumption Meter Reading Information

Introduction

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.

Request

A HTTP GET to the /ivp/meters/reports/consumption endpoint provides the following response data.

As of recent Gateway software versions this request requires user authentication and authorisation, see Authentication.

Response

Root

Name	Type	Values	Description
createdAt	Number	Number	The epoch date and time the message was generated.
reportType	String	MeasurementType (e.g. net-consumption)	What type of measurement this is reporting. In the format MeasurementType.
cumulative	Object	MeterReading object	The cumulative results of all the phases.
lines	Array(Object)	Array of MeterReading	The results for each of the phases.

MeterReading Object

Name	Type	Values	Description
currW	Number	Number	The current number of Watts.
actPower	Number	Number	The active power.
apprntPwr	Number	Number	The apparent power.
reactPwr	Number	Number	The reactive power.
whDlvdCum	Number	Number	The cumulative watt-hour delivered.
whRcvdCum	Number	Number	The cumulative watt-hour received.
varhLagCum	Number	Number	The cumulative lagging varh.
varhLeadCum	Number	Number	The cumulative leading varh.
vahCum	Number	Number	The cumulative vah.
rmsVoltage	Number	Number	The rms Voltage.
rmsCurrent	Number	Number	The rms Current.
pwrFactor	Number	Number	The power factor.
freqHz	Number	Number	The frequency in Hz.

Types

MeasurementType Type

Value	Name	Description
net-consumption	Net Consumption	Reporting the load with solar production included.
total-consumption	Total Consumption	Reporting the load only (solar production excluded).

Examples

Get Consumption Meter Reading Information

GET /ivp/meters/reports/consumption Response

[{"createdAt": 1686961636, "reportType": "total-consumption", "cumulative": {"currW": 435.983, "actPower": 435.983, "apprntPwr": 1228.326, "reactPwr": -1041.54, "whDlvdCum": 2631402.389, "whRcvdCum": 0.0, "varhLagCum": 795804.842, "varhLeadCum": 2831899.533, "vahCum": 5069093.617, "rmsVoltage": 243.847, "rmsCurrent": 5.037, "pwrFactor": 0.35, "freqHz": 50.12}, "lines": [{"currW": 435.983, "actPower": 435.983, "apprntPwr": 1228.326, "reactPwr": -1041.54, "whDlvdCum": 2631411.854, "whRcvdCum": 0.0, "varhLagCum": 795804.842, "varhLeadCum": 2831899.533, "vahCum": 5069093.617, "rmsVoltage": 243.847, "rmsCurrent": 5.037, "pwrFactor": 0.35, "freqHz": 50.12}]}, {"createdAt": 1686961636, "reportType": "net-consumption", "cumulative": {"currW": 435.311, "actPower": 435.311, "apprntPwr": 974.38, "reactPwr": -792.26, "whDlvdCum": 1749562.897, "whRcvdCum": 1601637.637, "varhLagCum": 17.665, "varhLeadCum": 2831899.135, "vahCum": 5069093.617, "rmsVoltage": 243.847, "rmsCurrent": 3.992, "pwrFactor": 0.45, "freqHz": 50.12}, "lines": [{"currW": 435.311, "actPower": 435.311, "apprntPwr": 974.38, "reactPwr": -792.26, "whDlvdCum": 1749562.897, "whRcvdCum": 1601637.637, "varhLagCum": 17.665, "varhLeadCum": 2831899.135, "vahCum": 5069093.617, "rmsVoltage": 243.847, "rmsCurrent": 3.992, "pwrFactor": 0.45, "freqHz": 50.12}]}]