v1

latestOpenAPI 3.0.02026-07-241010520.6 KB

Components

Retrieve Inverter

Retrieve details of an inverter

get/tenants/{tenant_id}/components/inverters/{inverter_id}

Path parameters

tenant_idstring uuid required

The ID of the tenant to get inverters for.

inverter_idstring uuid required

The ID of the inverter to retrieve.

Response

Inverter successfully retrieved.

idstring uuid

The ID of the inverter.

namestring

The name of the inverter.

manufacturerstring

The manufacturer of the inverter.

microinverterboolean

Whether the inverter is a microinverter.

nominal_output_voltagenumber nullable

The nominal output voltage of the inverter in volts.

rating_stcnumber nullable

The inverter's STC rating in watts.

cec_efficiency_pctnumber nullable

The inverter's CEC efficiency percentage.

weightnumber nullable

The weight of the inverter in kilograms.

spec_sheet_urlstring nullable

A URL to the inverter's specification sheet.

Example response

{
  "name": "Aurora Sample Inverter",
  "manufacturer": "Aurora Solar",
  "nominal_output_voltage": 240,
  "rating_stc": 350,
  "cec_efficiency_pct": 97,
  "weight": 20,
  "spec_sheet_url": "https://www.example.com/inverter-spec-sheet",
  "integrated_batteries": [
    {
      "name": "Aurora Sample Battery",
      "nominal_capacity": 13.5
    }
  ]
}