Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Enphase Energy

Enphase Energy Systems API

The Systems API from Enphase Energy — 13 operation(s) for systems.

Documentation Provider Profile APIs.io OpenAPI GitHub

Enphase Energy Systems API is one of 11 APIs that Enphase Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Systems. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 13 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.enphaseenergy.com/api/v2.

13 operations 13 paths 21 schemas 13 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.enphaseenergy.com/api/v4
Authentication
API Key
License
Enphase API License Agreement
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Enphase Energy Systems API declares 1 security scheme for authenticating requests. An API key is passed in the query as key (ApiKey). By default, every request must be authenticated.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.

Systems 13
GET
/systems/{system_id}/energy_lifetime
Returns a time series of energy produced on the system over its lifetime. All measurements are in Watt-hours. The time series includes one entry for each day from the startdate to the enddate. There…
EnergyLifetime 5 params → 200204401409422500503
GET
/systems/{system_id}/envoys
Returns a listing of all active Envoys currently deployed on the system.
Envoys 2 params → 200401409422500503
GET
/systems
Returns a list of systems for which the user can make API requests. There is a limit to the number of systems that can be returned at one time. If the first request does not return a full list, use t…
Systems 15 params → 200401409422500503
GET
/systems/{system_id}/inventory
Returns a listing of active devices on the given system. A device is considered active if it has not been retired in Enlighten. "Active" does not imply that the device is currently reporting, produci…
Inventory 2 params → 200401409422500503
GET
/systems/inverters_summary_by_envoy_or_site
Returns the summary along with the energy produced on the system over its lifetime.
InvertersSummaryByEnvoyOrSite 2 params → 200401409422500503
GET
/systems/{system_id}/monthly_productiondeprecated
This endpoint is deprecated and will be removed in a future release. Use productionmeterreadings or energylifetime instead. Returns the energy production of the system for the month starting on the g…
MonthlyProduction 3 params → 200401409422500503
GET
/systems/{system_id}/production_meter_readings
Returns the last known "odometer" reading of each revenue-grade production meter on the system as of the requested time. This endpoint includes entries for every production meter on the requested sys…
ProductionMeterReadings 3 params → 200401409422500503
GET
/systems/{system_id}/rgm_stats
Returns performance statistics as measured by the revenue-grade meters installed on the specified system. If the total duration requested is more than one month, returns one month of intervals. Inter…
RgmStats 4 params → 200401409422500503
GET
/systems/{system_id}/stats
Returns performance statistics for the specified system as reported by microinverters installed on the system. If the total duration requested is more than one day, returns one day of intervals. Inte…
Stats 4 params → 200401409422500503
GET
/systems/{system_id}/consumption_lifetime
Returns a time series of energy consumption as measured by the consumption meter installed on the specified system. All measurements are in Watt-hours. If the system does not have a meter, returns 20…
ConsumptionLifetime 4 params → 200401409422500503
GET
/systems/{system_id}/consumption_stats
Returns consumption as measured by the consumption meter installed on the specified system. If the total duration requested is more than one month, returns one month of intervals. Intervals are 15 mi…
ConsumptionStats 4 params → 200401409422500503
GET
/systems/{system_id}/summary
Returns summary information for the specified system.
Summary 3 params → 200401409422500503
GET
/systems/search_system_id
Get system ID by envoy serial number.
SearchSystemId 2 params → 200401404409422500503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are SummaryResponse (12 properties), UnprocessableEntityError (9 properties), EnergyLifetimeResponse (7 properties), ConflictError (6 properties). Each schema is shown below with its type and property counts.

Meta
object
Information about the system that you can use to ascertain the timeliness of the production data included in the response.
4 properties 4 required
UnprocessableEntityError
object
9 properties
Status
string
The current status of the system. comm - One or more Envoys on the system are not communicating to Enlighten. power - There is a production issue on the system…
StatsResponse
object
4 properties 4 required
SystemsResponse
object
2 properties 1 required
ServerError
object
2 properties 2 required
SummaryResponse
object
12 properties 12 required
ConflictError
object
6 properties 6 required
InvertersSummaryByEnvoyOrSiteResponse
object
2 properties 2 required
ProductionMeterReadingsResponse
object
3 properties 3 required
RgmStatsResponse
object
5 properties 5 required
ConnectionType
string
How the system is connected to the Internet.
ClientError
object
2 properties 2 required
NotFoundError
object
3 properties 1 required
EnergyLifetimeResponse
object
7 properties 4 required
ConsumptionLifetimeResponse
object
4 properties 3 required
MonthlyProductionResponse
object
6 properties 6 required
ConsumptionStatsResponse
object
4 properties 4 required
SearchSystemIdResponse
object
1 property 1 required
EnvoysResponse
object
2 properties 2 required
InventoryResponse
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

enphase-energy-systems-api-openapi.yml Raw ↑

Other APIs Enphase Energy publishes across the network.

Enphase Enlighten Commissioning API
AE Profile APIs.io
Enphase VPP API
AE Profile APIs.io
Enphase Energy Device Level Production Monitoring API
AE Profile APIs.io
Enphase Energy EV Charger Control API
AE Profile APIs.io
Enphase Energy EV Charger Monitoring API
AE Profile APIs.io
Enphase Energy Site Level Consumption Monitoring API
AE Profile APIs.io
Enphase Energy Site Level Production Monitoring API
AE Profile APIs.io
Enphase Energy Streaming APIs API
AE Profile APIs.io
Enphase Energy System Configurations API
AE Profile APIs.io
Enphase Energy System Details API
AE Profile APIs.io
#Systems
← Back to E APIs
API Details
ID
enphase-energy:enphase-energy-systems-api
Base URL
https://api.enphaseenergy.com/api/v4
Docs
https://developer-v4.enphase.com/
Provider
Enphase Energy
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network