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

Enphase Energy System Details API

The System Details API from Enphase Energy — 10 operation(s) for system details.

Enphase Energy System Details 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 System Details. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 10 paths, and defines 3 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.

10 operations 10 paths 3 schemas 9 GET1 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

Enphase Energy System Details 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 10

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

System Details 10
GET
/api/v4/systems
Fetch systems
listSystems 3 params → 200401405422429501
POST
/api/v4/systems/search
Search and filter systems
searchSystems 2 params body → 200401405422429501
GET
/api/v4/systems/{system_id}
Retrieves a System by id
getSystemById 1 param → 200401403404405429501
GET
/api/v4/systems/{system_id}/summary
Retrieves a system summary
getSystemSummary 1 param → 200401403404405429501
GET
/api/v4/systems/{system_id}/devices
Retrieves devices for a given system
listSystemDevices 1 param → 200401403404405429500501
GET
/api/v4/systems/retrieve_system_id
Retrieve system for a given envoy serial number
retrieveSystemId 1 param → 200401404405422429501
GET
/api/v4/systems/{system_id}/events
To retrieve the list of events for a site
listSystemEvents 3 params → 200401403404405422429501
GET
/api/v4/systems/{system_id}/alarms
To retrieve the list of alarms for a site
listSystemAlarms 4 params → 200401403404405422429501
GET
/api/v4/systems/event_types
To retrieve the list of eventtypeid along with eventdescription and recommendedaction
listEventTypes 1 param → 200401404405429501
GET
/api/v4/systems/inverters_summary_by_envoy_or_site
inverterssummarybyenvoyorsite
getInvertersSummary 4 params → 200401405422429501

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

SystemConnectionType
string
Connection type reported by the system.
EventStatus
string
Lifecycle state reported for events.
MicroinverterAttachmentType
string
Microinverter attachment style configured for the system.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

enphase-energy-system-details-api-openapi.yml Raw ↑

Other APIs Enphase Energy publishes across the network.

Enphase Enlighten Commissioning API
Enphase VPP API
Enphase Energy Device Level Production Monitoring API
Enphase Energy EV Charger Control API
Enphase Energy EV Charger Monitoring API
Enphase Energy Site Level Consumption Monitoring API
Enphase Energy Site Level Production Monitoring API
Enphase Energy Streaming APIs API
Enphase Energy System Configurations API
Enphase Energy Systems API