Release Notes

New Enhancements

  • Added a new field reference and other_references in the /api/v4/systems endpoint. If the calling user belongs to a company and that company has provided its own identifier for a system, that ID is called reference. If any other companies have provided their own identifiers for a system, those identifiers are called other_references.
  • Added a new field emu_sw_version under gateways in the /api/v4/systems/{system_id}/devices endpoint. It is the firmware version of the gateway for a given site.
  • Added a new field energy_lifetime, energy_today and system_size in the /api/v4/systems endpoint. energy_lifetime is the energy generated by the system during its lifetime in Wh, energy_today is the energy generated by the system today in Wh, and system_size is the size of the system.

Throttling limits for PUT, POST and DELETE endpoints under partner plan

  • For each of the PUT, POST and DELETE endpoints under partner plan, throttling limit is 200 hits per month now. Each of the GET endpoints under the partner plan are not impacted.

Enhancements to battery telemetry and users endpoint

  • Added a new field last_reported_aggregate_soc in the /api/v4/systems/{system_id}/telemetry/battery endpoint. It is the latest aggragate SOC value of all the batteries for a given site.
  • Added a new field last_reported_time and last_reported_soc in the /api/v4/systems/{system_id}/devices/acbs/{serial_no}/telemetry and /api/v4/systems/{system_id}/devices/encharges/{serial_no}/telemetry endpoint. last_reported_time is the timestamp (in epoch format) at which the device last submitted a report and last_reported_soc is the latest SOC value reported by the device.
  • Added a new field company_id in the /api/v4/users/search endpoint. It is the Enlighten ID of the company that the user belongs to. If the user does not belong to a company, this field will not be present in the response.

Enphase API v4 is released

Enphase API v4 is released with the following improvements over Enphase API v2

  • Enphase API v4 adheres to OAuth 2.0 protocol for authorization with grant_type as authorization_code for Monitoring APIs and grant_type as password for commissioning APIs.
  • Each API request must include OAuth2 access_token and API key as inputs, this enables an application to get access to Enphase systems data in a secured and simplified manner.
  • API v4 provides access to battery level and microinverter level data, in addition to site level production and consumption monitoring data.
  • API v4 supports fine grained access control, giving the application developers the ability to choose access control for each application.
  • Installer specific 'Partner Plan' is self-serve and gives access to commissioning APIs for their installed and maintained systems. Only registered Enphase installers with at least 10 installations can sign up for Partner plan.

Enphase API v4 and Enphase API v2 parity

  • /api/v2/systems/{system_id}/stats is now replaced with /api/v4/systems/{system_id}/telemetry/production_micro
  • /api/v2/systems/{system_id}/consumption_stats is now replaced with /api/v4/systems/{system_id}/telemetry/consumption_meter
  • /api/v2/systems/{system_id}/inventory is now replaced with /api/v4/systems/{system_id}/devices
  • /api/v2/systems/{system_id}/summary is now replaced with /api/v4/systems/{system_id}/summary
  • /api/v2/systems/search_system_id is now replaced with /api/v2/systems/retrieve_system_id
  • /api/v2/systems/{system_id}/envoys, /api/v2/systems/{system_id}/monthly_production are now deprecated
  • Following endpoints are the same in API v4 as in API v2:
    • /systems/{system_id}/consumption_lifetime
    • /systems/{system_id}/energy_lifetime
    • /systems/inverters_summary_by_envoy_or_site
    • /systems/production_meter_readings
    • /systems/{system_id}/rgm_stats
    • /systems/summary

Date range restrictions are imposed on telemetry APIs.

  • The requested start date must be within 2 years from current date for the following endpoints: /systems/{system_id}/rgm_stats, /systems/{system_id}/telemetry/production_micro, /systems/{system_id}/telemetry/production_meter, /systems/{system_id}/telemetry/battery, /systems/{system_id}/telemetry/consumption_meter, /systems/{system_id}/devices/micros/{serial_no}/telemetry, /systems/{system_id}/devices/acbs/{serial_no}/telemetry, /systems/{system_id}/devices/encharges/{serial_no}/telemetry
  • The total duration requested can not be more than one week, for the following endpoints: /systems/{system_id}/telemetry/production_micro, /systems/{system_id}/telemetry/production_meter, /systems/{system_id}/telemetry/battery, /systems/{system_id}/telemetry/consumption_meter, /systems/{system_id}/devices/micros/{serial_no}/telemetry, /systems/{system_id}/devices/acbs/{serial_no}/telemetry, /systems/{system_id}/devices/encharges/{serial_no}/telemetry