openapi: 3.0.0
info:
title: The Enlighten Systems API
description: |-
The Enlighten Systems API is a JSON-based API that provides access to performance data for a PV system. By using the Enlighten Systems API, you agree to the Enphase Energy API License Agreement.
Please note that the Enlighten Systems API does not provide performance data at a panel or microinverter level.
version: '2.0'
termsOfService: https://developer.enphase.com/docs#Display-Requirements
license:
name: Enphase API License Agreement
url: https://www.enphase.com/en-us/legal/api-license-agreement
servers:
- url: 'https://api.enphaseenergy.com/api/v2'
paths:
'/systems/{system_id}/energy_lifetime':
get:
description: |-
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 `start_date` to the `end_date`. There are no gaps in the time series. If the response includes trailing zeroes, such as
`[909, 4970, 0, 0, 0]`, then no energy has been reported for the last days in the series. You can check the system's status in the `meta` attribute of the response to determine when the
system last reported and whether it has communication or production problems.
If the system has a meter, the time series includes data as measured by the microinverters until the first full day after the meter has been installed, when it switches to using the data as
measured by the meter. This is called the "merged time series". In addition, the response includes the attribute `meter_start_date`, to indicate where in the time series the meter
measurements begin to be used. You can retrieve the complete time series from the meter and from the microinverters by adding the parameter `production=all` to the request.
operationId: EnergyLifetime
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_date
description: The date on which to start the time series. Defaults to the system's operational date.
in: query
schema:
type: string
format: date
example: '2013-01-01'
- name: end_date
description: The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier.
in: query
schema:
type: string
format: date
example: '2013-01-06'
- name: production
description: When `all`, returns the merged time series plus the time series as reported by the microinverters and the meter on the system. Other values are ignored.
in: query
schema:
type: string
enum:
- all
example: all
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EnergyLifetimeResponse'
'204':
description: No Content
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/envoys':
get:
description: Returns a listing of all active Envoys currently deployed on the system.
operationId: Envoys
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EnvoysResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems':
get:
description: |-
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 the `next` attribute in the response body to request the next page of systems. By default, systems are returned in batches of 100. The maximum page size is 1000.
operationId: Systems
parameters:
- $ref: '#/components/parameters/UserId'
- name: next
in: query
schema:
type: string
example: 4d5467784d5445770a
- name: limit
in: query
schema:
type: integer
default: 100
maximum: 1000
example: 100
- name: system_id
in: query
schema:
type: integer
example: 67
- name: 'system_id[]'
in: query
schema:
type: array
items:
type: integer
example:
- 67
- name: system_name
in: query
schema:
type: string
example: Green
- name: 'system_name[]'
in: query
schema:
type: array
items:
type: string
example:
- Green
- name: status
in: query
schema:
$ref: '#/components/schemas/Status'
example: power
- name: 'status[]'
in: query
schema:
type: array
items:
$ref: '#/components/schemas/Status'
example:
- comm
- micro
- name: reference
in: query
schema:
type: string
- name: 'reference[]'
in: query
schema:
type: array
items:
type: string
- name: installer
in: query
schema:
type: string
- name: 'installer[]'
in: query
schema:
type: array
items:
type: string
- name: connection_type
in: query
schema:
$ref: '#/components/schemas/ConnectionType'
- name: 'connection_type[]'
in: query
schema:
type: array
items:
$ref: '#/components/schemas/ConnectionType'
example:
- ethernet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SystemsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/inventory':
get:
description: |-
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, producing, or measuring energy.
operationId: Inventory
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/inverters_summary_by_envoy_or_site':
get:
description: Returns the summary along with the energy produced on the system over its lifetime.
operationId: InvertersSummaryByEnvoyOrSite
parameters:
- $ref: '#/components/parameters/UserId'
- name: site_id
description: The identifier of the system.
in: query
required: true
schema:
type: integer
example: 66
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InvertersSummaryByEnvoyOrSiteResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/monthly_production':
get:
deprecated: true
description: |-
This endpoint is deprecated and will be removed in a future release. Use `production_meter_readings` or `energy_lifetime` instead.
Returns the energy production of the system for the month starting on the given date. The start date must be at least one month ago. If a meter or meters are installed on the system,
measurements come from the meter; otherwise, measurements come from the microinverters.
This endpoint can return a response of Data Temporarily Unavailable.
operationId: MonthlyProduction
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_date
description: |-
Start date for reporting period. The reporting period ends on the previous day of the next month; for example, a `start_date` of 2011-07-20 returns data through 2011-06-19. When the
start date is the first of a calendar month, the end date is the last day of that month.
in: query
required: true
schema:
type: string
format: date
example: '2011-07-01'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MonthlyProductionResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/production_meter_readings':
get:
description: |-
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 system, regardless of whether the meter is currently in service or retired. `read_at` is the time at which the
reading was taken, and is always less than or equal to the requested `end_at`. Commonly, the reading will be within 30 minutes of the requested `end_at`; however, larger deltas can occur and
do not necessarily mean there is a problem with the meter or the system it is on. Systems that are configured to report infrequently can show large deltas on all meters, especially when
`end_at` is close to the current time. Meters that have been retired from a system will show an `end_at` that doesn't change, and that eventually is far away from the current time.
operationId: ProductionMeterReadings
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: end_at
in: query
schema:
type: integer
format: int64
example: 1473901755
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProductionMeterReadingsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/rgm_stats':
get:
description: |-
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. Intervals are 15 minutes in length and start at the top of the hour.
Requests for times that do not fall on the 15-minute marks are rounded down. For example, a request for 08:01, 08:08, 08:11, or 08:14 is treated as a request for 08:00. Intervals are listed
by their end dates; therefore, the first interval returned is 15 minutes after the requested start date.
If the system doesn't have any revenue-grade meters installed, the response includes an empty intervals array.
Under some conditions, data for a given period may be temporarily unavailable.
operationId: RgmStats
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_at
description: |-
Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago,
the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`.
in: query
schema:
type: integer
format: int64
example: 1381474800
- name: end_at
description: |-
End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with
the last reported interval.
in: query
schema:
type: integer
format: int64
example: 1381561200
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RgmStatsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/stats':
get:
description: |-
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. Intervals are 5 minutes in length and start at the top of the hour.
Requests for times that do not fall on the 5-minute marks are rounded down. For example, a request for 08:01, 08:02, 08:03, or 08:04 is treated as a request for 08:00. Intervals are listed
by their end dates; therefore, the first interval returned is 5 minutes after the requested start date.
The response includes intervals that have been reported for the requested period. Gaps in reporting are not filled with 0-value intervals. The dark hours on a system are an example of such a
gap, because the microinverters do not produce at night.
Sometimes a request cannot be processed because the requested dates are invalid for the system in question. Examples include asking for stats starting at a time that is later than the
system's last reported interval, or asking for stats before a system has started production. In cases such as these, the response code is `422` and the response body includes an error reason
as well as the parameters used to process the request.
If the system doesn't have any microinverters installed, the response includes an empty intervals array. Under some conditions, data for a given period may be temporarily unavailable.
operationId: Stats
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_at
description: |-
Start of reporting period in Unix epoch time. If no start is specified, defaults to midnight today, in the timezone of the system. If the start date is earlier than one year ago today,
the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the `operational_date`.
in: query
schema:
type: integer
format: int64
example: 1381496100
- name: end_at
description: |-
End of reporting period in Unix epoch time. If no end is specified, the assumed end is now. If the end is later than the last reporting interval the response data ends with the last
reported interval.
in: query
schema:
type: integer
format: int64
example: 1381497600
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/consumption_lifetime':
get:
description: |-
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 `204` - No Content. If you don't have permission to view consumption data, the response code is `401`.
The time series includes one entry for each day from the `start_date` to the `end_date`. There are no gaps in the time series. If the response includes trailing zeroes, such as
[909, 4970, 0, 0, 0], then no data has been reported for the last days in the series. You can check the system's status in the `meta` attribute of the response to determine when the system
last reported and whether it has communication or metering problems.
operationId: ConsumptionLifetime
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_date
description: The date on which to start the time series. Defaults to the system's operational date.
in: query
schema:
type: string
format: date
example: '2016-07-01'
- name: end_date
description: The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier.
in: query
schema:
type: string
format: date
example: '2016-07-31'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumptionLifetimeResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/consumption_stats':
get:
description: |-
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 minutes in length and start at the top of the hour.
Requests for times that do not fall on the 15-minute marks are rounded down. For example, a request for 08:01, 08:08, 08:11, or 08:14 is treated as a request for 08:00. Intervals are listed
by their end dates; therefore, the first interval returned is 15 minutes after the requested start date.
If the system doesn't have any consumption meters installed, the response includes an empty intervals array.
If you don't have permission to view consumption data, the response code is `401`.
Under some conditions, data for a given period may be temporarily unavailable.
operationId: ConsumptionStats
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: start_at
description: |-
Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago,
the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`.
in: query
schema:
type: integer
format: int64
example: 1448946000
- name: end_at
description: |-
End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with
the last reported interval.
in: query
schema:
type: integer
format: int64
example: 1449011615
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumptionStatsResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/{system_id}/summary':
get:
description: Returns summary information for the specified system.
operationId: Summary
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/SystemId'
- name: summary_date
description: |-
Start of reporting period. If no `summary_date` is provided, the start is the current day at midnight site-local time. Otherwise, the start is midnight site-local time of the requested
day. If the requested date cannot be parsed or is in the future, the response includes an informative error message and `422` status.
in: query
schema:
type: string
format: date
example: '2010-09-17'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SummaryResponse'
'401':
$ref: '#/components/responses/ClientError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
'/systems/search_system_id':
get:
description: Get system ID by envoy serial number.
operationId: SearchSystemId
parameters:
- $ref: '#/components/parameters/UserId'
- name: serial_num
description: Serial number of the envoy.
in: query
required: true
schema:
type: string
example: '23435345345'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SearchSystemIdResponse'
'401':
$ref: '#/components/responses/ClientError'
'404':
$ref: '#/components/responses/NotFoundError'
'409':
$ref: '#/components/responses/ConflictError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServerError'
components:
schemas:
EnergyLifetimeResponse:
type: object
properties:
start_date:
description: |-
When no `start_date` parameter is specified on the request, this is the `operational_date` of the system. May be null if system has never produced. When a `start_date`
parameter is included in the request, it is included here in the response.
type: string
format: date
system_id:
description: The identifier of the system.
type: integer
production:
description: |-
An array of production measurements, one for each day since the system started producing, or one for each day of the requested period. If the system has never produced energy,
the array may be empty.
type: array
items:
type: integer
micro_production:
type: array
items:
type: integer
meter_production:
type: array
items:
type: integer
meter_start_date:
description: The first day in the time series when measurements are taken from a meter instead of from microinverters. This field is not present unless the system has a meter.
type: string
format: date
meta:
$ref: '#/components/schemas/Meta'
required:
- start_date
- system_id
- production
- meta
example:
start_date: '2013-01-01'
system_id: 66
production:
- 15422
- 15421
- 17118
- 18505
- 18511
- 18487
meter_start_date: '2013-02-15'
meta:
status: normal
last_report_at: 1445619615
last_energy_at: 1445619033
operational_at: 1357023600
EnvoysResponse:
type: object
properties:
system_id:
description: The identifier of the system.
type: integer
envoys:
description: A list of active Envoys on this system.
type: array
items:
type: object
properties:
envoy_id:
description: The Enlighten ID of the Envoy.
type: integer
last_report_at:
description: |-
The last time this Envoy submitted a report, by default expressed in Unix epoch time. When the `datetime_format` query parameter is `iso8601`, `last_report_at` is in
ISO 8601 format. If Enlighten has no record of a report from this Envoy, returns null.
type: integer
format: int64
name:
description: The human-friendly name of this Envoy.
type: string
part_number:
description: The Enphase part number of this Envoy.
type: string
serial_number:
description: The serial number of this Envoy.
type: string
status:
description: |-
The current status of this Envoy.
* `normal` - The Envoy is operating normally.
* `comm` - The Envoy is not communicating to Enlighten.
type: string
enum:
- normal
- comm
required:
- envoy_id
- last_report_at
- name
- part_number
- serial_number
- status
required:
- system_id
- envoys
example:
system_id: 67
envoys:
- envoy_id: 512
last_report_at: 1308008107
name: Envoy 010731000003
part_number: 800-00002-r00
serial_number: '010731000003'
status: normal
- envoy_id: 841
last_report_at: null
name: Envoy 010814000001
part_number: 910-10000-r01
serial_number: '010814000001'
status: normal
SystemsResponse:
type: object
properties:
systems:
type: array
items:
type: object
properties:
system_id:
description: The Enlighten ID of the system.
type: integer
system_name:
description: |-
The name of the system. Even if the system owner has indicated their site is anonymous for public lists, the actual system name is returned here for identification
purposes.
type: string
system_public_name:
description: The display name of the system. Use this when displaying the system name on a public list or view.
type: string
reference:
description: |-
If the calling user belongs to a company and that company has provided its own identifiers for a system, that ID is included here. Otherwise, this attribute is not
returned.
type: string
other_references:
description: If any other companies have provided their own identifiers for a system, those identifiers are included here. Otherwise, this attribute is not returned.
type: array
items:
type: string
country:
description: The two-letter code for the country where the system is located. See [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for reference.
type: string
minLength: 2
maxLength: 2
state:
description: The two-letter code for the state where the system is located. See [ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) for reference.
type: string
minLength: 2
city:
description: The name of the city where the system is located.
type: string
postal_code:
description: The postal code where the system is located.
type: string
timezone:
description: The timezone of the system.
type: string
connection_type:
$ref: '#/components/schemas/ConnectionType'
status:
deprecated: true
description: The current status of the system. You can find this and more in the `meta` property.
type: string
enum:
- comm
- power
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/enphase-energy/refs/heads/main/openapi/enphase-enlighten-v2-openapi.yml