📘

These endpoints are part of the Platform API. See the Aurora Solar API section for details.

Note that this is an asynchronous set of endpoints. See the Asynchronous Endpoints appendix for more info.

In Aurora, an irradiance analysis is a simulation of the amount of solar energy that will be available to a solar installation over the course of the year, given any shade that is present as well as the local weather patterns. From the Aurora API, after using this set of endpoints to trigger and check the status of an irradiance analysis job, shading data (monthly SAP and annual TSRF) can be accessed via the Design Summary endpoint on a per-array basis.

Upon successful completion of an irradiance analysis job, a new panels irradiance analysis will saved for the corresponding design_id. Note that the pre-existing panels irradiance analysis will be replaced when the new job completes. Additionally, upon completion of the asynchronous job, a webhook can be sent out to: https://HOST/PATH/irradiance_analysis_job_completion?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>

  • <DESIGN_ID> is the ID of the design for which the irradiance analysis was run.

  • <JOB_ID> is the ID identifying the specific irradiance analysis job.

  • <STATUS> is the status of the completed irradiance analysis job ("succeeded" or "failed").

To set up this webhook, please contact your Aurora Account Executive or the Aurora support team at [email protected]