API Reference

Components

Aurora estimates PV system product by modeling how individual components (e.g. modules, inverter, and DC optimizers) impact PV system production that Aurora will model. With the Components API, you can retrieve summary data for Aurora components.

Use cases

Common Components API use cases include:

  • Retrieve parameters of components used in your Aurora designs via Sync API to orchestrate post-sales workflows.
  • Determine which component IDs to use when placing panels via Run AutoDesigner API.
  • Retrieve module dimensions and weight to model racking.

Component database

Aurora maintains a comprehensive database of components used worldwide including:

  • Modules
  • Inverters
  • DC optimizers
  • Combiner boxes
  • Load centers
  • Disconnects
  • Service panels
  • Meters
  • Batteries

Each component record in the Aurora database includes name of the manufacturer, component model, electrical parameters, physical parameters, temperature parameters, and spec sheet.

Sample spec sheet for a module
Sample spec sheet for a module

How the component database is populated

A team of Aurora solar engineers works with component manufacturers to keep the component database up-to-date and ensure that component records have sufficient information to accurately model system production. The components are globally unique and shared across tenants unless they are one of the few custom components requested by your Administrator and only available in your tenant.

How components are selected in designs

Which components are used in each design is determined in the Aurora app, database settings, tenant settings, and, optionally, project settings configured via Sync API. When placing modules in Sales Mode or Design Mode, for example, users in your tenant can choose which component to use. In addition, your tenant Administrators have the ability to “recommended” components that will be available for quick selection to your designers, and to limit designers to only "enabled" components. Administrators also can specify which inverter manufacturers should be used in all designs in your tenant. Lastly, with preferred_solar_modules field, you can set the modules that AutoDesigner will use via Sync API.

Select a module in Design Mode
Select a module in Design Mode

Set recommended modules in the Aurora database
Set recommended modules in the Aurora database

Set default inverter manufacturer
Set default inverter manufacturer

Considerations

  • Aurora Solar engineers try to keep component databases in sandbox and production tenants in sync. However, the component database in sandbox may sometimes lag behind the one in production tenants.
  • You can look up the ID of each component app by looking at the URL of that component in the database.

View component details in the Aurora database
View component details in the Aurora database