Many partner applications have a need to map Aurora components such as solar modules to modules in their own system. We provide endpoints to retrieve data about the modules so you can stay in sync with new additions.

This functionality is available in both the sandbox and production environments. Please keep in mind that the id values you receive from the endpoints will vary across environments. In other words, you will not be able to use the same mappings for sandbox and production.

All endpoints listed below can be accessed using your application key as your bearer token.

Retrieving all solar modules

A full list of solar modules supported globally by Aurora can be retrieved by sending a GET request to /partner_applications/{application_id}/components/modules. This endpoint is primarily intended for doing an initial mapping of panels in your own system to panels in Aurora. It will also include any tenant-specific components defined by customers who have your app enabled.

The response will be a CSV containing Aurora id, module name, manufacturer name, rating, length (mm), width (mm), height (mm) and weight (kg).

curl 'https://api.aurorasolar.com/partner_applications/{application_id}/components/modules' \
  --header 'Accept: text/csv' \
  --header 'Authorization: Bearer {application_key}'

id,name,manufacturer,rating_stc,length,width,height,weight
cc1079f8-53e6-458b-bb72-c7003d9fd983,Aurora Sample Solar Panel,Aurora Sample Manufacturer,335.0,1559.0,1046.0,46.0,18.6
...

Requests to this endpoint must include an Accept: text/csv header. The authentication token used for this endpoint is your application key. Note that although a successful response will be returned in CSV format, errors will be formatted as JSON in order to provide useful debugging information.

Fields containing commas will be wrapped in double quotes (e.g. Acme, Inc will be represented as "Acme, Inc"). Similarly double quotes will be replaced with a pair of double quotes (e.g. The "Quote" Company will be represented as "The ""Quote"" Company").

Retrieving individual solar modules

If you need to lookup data for a specific solar module, you can use the retrieve module endpoint. This will provide you with the same information as the CSV endpoint but for a specific panel.

curl 'https://api.aurorasolar.com/partner_applications/{application_id}/components/modules/{module_id}' \
--header 'Authorization: Bearer {application_key}'

{
    "module": {
        "units_of_measurement": "metric",
        "name": "Aurora Sample Solar Panel",
        "manufacturer": "Aurora Sample Manufacturer",
        "rating_stc": 335.0,
        "dimensions": {
            "length": 1559.0,
            "width": 1046.0,
            "height": 46.0
        },
        "weight": 18.6
    }
}