> ## Documentation Index > Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt > Use this file to discover all available pages before exploring further. # Get inverter overview list > # Inverter Overview Returns a list of all available Inverters however with simplified data properties. ## Overview This endpoint provides a lightweight version of the full inverter list, returning essential inverter information without the complete technical specifications and detailed configuration data. It's optimized for scenarios where you need a quick overview of available inverters without the overhead of fetching complete inverter records. ## Response Fields The simplified response includes the following fields for each inverter: | Field | Type | Description | | --- | --- | --- | | `id` | integer | Unique identifier for the inverter | | `ownerId` | integer | ID of the user or organization that owns this inverter configuration | | `name` | string | Display name for the inverter | | `status` | integer | Current status of the inverter record (1=Draft, 2=In Review, 3=Active, 4=Archived) | | `lastModified` | string (ISO 8601) | Timestamp of the last modification to this inverter record | | `lastModifiedBy` | object | User who last modified the record | | `lastModifiedBy.firstName` | string | First name of the user who last modified the record | | `lastModifiedBy.lastName` | string | Last name of the user who last modified the record | | `model` | string | Manufacturer's model number/name for the inverter | | `manufacturer` | string | Name of the inverter manufacturer | | `powerRated` | number | Rated power output of the inverter in kW | | `outputVoltage` | number | Output voltage of the inverter in volts | | `minVoltage` | number | Minimum operating voltage in volts | | `maxMPPVoltage` | number | Maximum Power Point (MPP) voltage in volts | | `inverterType` | integer | Type classification of the inverter (1=String Inverter, 2=Central Inverter) | ## Excluded Fields Compared to the full inverter endpoint, this simplified overview **excludes**: - Detailed efficiency curves and performance data - Complete electrical specifications and ratings - Thermal characteristics and derating factors - Advanced configuration parameters - Certification and compliance documentation - Extended metadata and custom fields ## Use Cases ### When to Use This Endpoint - **Dashboard displays** - Populating dropdown lists or selection menus - **Quick searches** - Finding inverters by name or manufacturer without loading full details - **List views** - Displaying tables of available inverters with basic information - **Performance optimization** - Reducing payload size and response time for overview screens - **Mobile applications** - Minimizing data transfer for bandwidth-constrained environments ### When to Use the Full Endpoint - **Detailed analysis** - When you need complete technical specifications for engineering calculations - **Configuration management** - Setting up or modifying inverter parameters in a project - **Reporting** - Generating comprehensive reports that require all inverter data - **Data export** - Extracting complete inverter information for external systems ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Inverter/InverterOverview openapi: 3.1.0 info: title: PlantPredict API version: 12.13.0 description: > ## What is PlantPredict? PlantPredict is an industry-leading performance modeling platform for utility-scale solar power plants. It predicts energy yield across the full project lifecycle — from early-stage site prospecting through detailed engineering and operational monitoring. The same engine that powers the PlantPredict web UI is fully exposed via this REST API, enabling automation of complex, high-time-resolution energy predictions without any UI interaction. ## Domain Model — read this first Understanding the object hierarchy is essential before calling the API: - **Weather** — A weather file (hourly irradiance, temperature, wind, etc.) for a geographic location. Imported from a provider (e.g. SolarAnywhere, Meteonorm) or uploaded manually. Weather files live in a company-wide library and are referenced by Predictions. - **Module** — A PV module definition parameterized with electrical characteristics (STC power, temperature coefficients, single-diode model parameters, IAM curves, etc.). Modules live in a company-wide library. - **Inverter** — An inverter definition with efficiency curves, voltage/power ratings, and optional kVA derating curves. Inverters live in a company-wide library. - **Project** — A named location (lat/lon) that acts as a container for one or more Predictions. Holds geographic metadata (country, elevation, UTC offset) and a status. - **Prediction** — The core simulation configuration nested under a Project. Defines the simulation period, model selections (transposition, air mass, degradation, soiling, shading, spectral shift models), uncertainty error terms, and references to a Weather file. A Prediction must be linked to a PowerPlant before it can be run. Status values: 0 = Draft, 1 = Active, 2 = Issued, 3 = Archived. - **PowerPlant** — The physical plant design attached to a Prediction. Describes the electrical topology: Blocks → Arrays → Inverters → DC Fields (strings of modules). Also includes transformers, transmission lines, energy storage (ESS), availability losses, and LGIA export limits. - **Shade Scene** — An optional 3D shading model (PVJ format) attached to a Prediction's DC Fields. Supports import from PVC or SHD files. Shade and TABT (Tracker Angle Back-Tracking) calculations are queued and run asynchronously. ## Typical workflow to run a prediction 1. Ensure a **Weather** file exists (search, download, or import one). 2. Ensure a **Module** and **Inverter** exist in the library. 3. **POST /Project** — create a project at the site location. 4. **POST /Project/{projectId}/Prediction** — create a prediction with model settings. 5. **POST /Project/{projectId}/Prediction/{predictionId}/PowerPlant** — attach a plant design referencing your module and inverter. 6. **POST /Project/{projectId}/Prediction/{predictionId}/Run** — queue the simulation. 7. Poll **GET /Project/{projectId}/Prediction/{predictionId}/Overview** until `status` reaches 2 (complete), then retrieve results via `/ResultSummary`, `/ResultDetails`, or `/NodalJson`. ## Authentication OAuth 2.0 **Client Credentials** flow via AWS Cognito. The spec advertises a single `bearerAuth` scheme — fetch a token yourself with the snippet below, then either paste it into the in-browser playground or pass it on every request as `Authorization: Bearer `. > **Why not advertise OAuth2 directly?** Most users have access to the > production tenant only, and we don't want to invite anyone to enter > long-lived `client_id` / `client_secret` credentials into a third-party > documentation site. Keep credentials in your own environment; ship > short-lived bearer tokens to wherever they are needed. - Token URL: `https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token` - Scopes: `transactions/get` (read), `transactions/post` (write) — request both to access the entire surface. - Send credentials as **Basic Auth** in the token request header. Example: ```bash curl -X POST 'https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token' \ -u "$PP_CLIENT_ID:$PP_CLIENT_SECRET" \ -d 'grant_type=client_credentials&scope=transactions/get transactions/post' ``` API credentials (Client ID + Secret) are generated per user by a company admin inside the PlantPredict UI (gear icon → user profile → Generate API Credentials). Store them securely — they are shown only once. ## Notes - All request/response bodies are JSON (`Content-Type: application/json`). - The API is stateless — every request must supply complete inputs; there is no session. - POST operations that create entities return `{"id": }`. - Many integer fields (model types, status codes) map to named enums — use `GET /Definitions` to retrieve the full enum catalog at runtime. - Long-running operations (Run, Shade calculations, TABT) are asynchronous; poll the corresponding `ProcessingStatus` endpoint to track progress. - Responses may include an `X-Message` header with non-blocking warnings (e.g. duplicate project name). servers: - url: https://api.plantpredict.terabase.energy description: Production security: - bearerAuth: [] tags: - name: Definitions description: Enum and model type definitions - name: Projects description: Solar project management - name: Predictions description: Energy prediction configuration and execution - name: PowerPlant description: Power plant design (blocks, arrays, inverters, transformers) - name: TimeSeries description: Custom time series data inputs - name: Results description: Prediction results — summary, details, nodal, average energy - name: FinancialModel description: Financial model parameters and cashflow results - name: Reports description: Report generation and export - name: ShadeScene description: 3D shade scene management and calculations - name: Weather description: Weather file import, download, and management - name: Inverters description: Inverter library management - name: Modules description: PV module library and single-diode parameter generation - name: ASHRAE description: ASHRAE climate station lookup - name: System description: System version and maintenance status - name: Company description: Company settings and user management - name: Country description: Reference country data paths: /Inverter/InverterOverview: get: tags: - Inverters summary: Get inverter overview list description: > # Inverter Overview Returns a list of all available Inverters however with simplified data properties. ## Overview This endpoint provides a lightweight version of the full inverter list, returning essential inverter information without the complete technical specifications and detailed configuration data. It's optimized for scenarios where you need a quick overview of available inverters without the overhead of fetching complete inverter records. ## Response Fields The simplified response includes the following fields for each inverter: | Field | Type | Description | | --- | --- | --- | | `id` | integer | Unique identifier for the inverter | | `ownerId` | integer | ID of the user or organization that owns this inverter configuration | | `name` | string | Display name for the inverter | | `status` | integer | Current status of the inverter record (1=Draft, 2=In Review, 3=Active, 4=Archived) | | `lastModified` | string (ISO 8601) | Timestamp of the last modification to this inverter record | | `lastModifiedBy` | object | User who last modified the record | | `lastModifiedBy.firstName` | string | First name of the user who last modified the record | | `lastModifiedBy.lastName` | string | Last name of the user who last modified the record | | `model` | string | Manufacturer's model number/name for the inverter | | `manufacturer` | string | Name of the inverter manufacturer | | `powerRated` | number | Rated power output of the inverter in kW | | `outputVoltage` | number | Output voltage of the inverter in volts | | `minVoltage` | number | Minimum operating voltage in volts | | `maxMPPVoltage` | number | Maximum Power Point (MPP) voltage in volts | | `inverterType` | integer | Type classification of the inverter (1=String Inverter, 2=Central Inverter) | ## Excluded Fields Compared to the full inverter endpoint, this simplified overview **excludes**: - Detailed efficiency curves and performance data - Complete electrical specifications and ratings - Thermal characteristics and derating factors - Advanced configuration parameters - Certification and compliance documentation - Extended metadata and custom fields ## Use Cases ### When to Use This Endpoint - **Dashboard displays** - Populating dropdown lists or selection menus - **Quick searches** - Finding inverters by name or manufacturer without loading full details - **List views** - Displaying tables of available inverters with basic information - **Performance optimization** - Reducing payload size and response time for overview screens - **Mobile applications** - Minimizing data transfer for bandwidth-constrained environments ### When to Use the Full Endpoint - **Detailed analysis** - When you need complete technical specifications for engineering calculations - **Configuration management** - Setting up or modifying inverter parameters in a project - **Reporting** - Generating comprehensive reports that require all inverter data - **Data export** - Extracting complete inverter information for external systems operationId: getInverterOverview responses: '200': description: Inverter overviews content: application/json: schema: type: array items: $ref: '#/components/schemas/InverterOverview' examples: postman-inverter-overview: value: - id: 8344 ownerId: 5109 name: Ginlong Technologies Solis-125K-EHV-5G status: 3 lastModified: '2022-02-04T13:54:22.28' lastModifiedBy: firstName: Martin lastName: Schneider model: Solis-125K-EHV-5G manufacturer: Ginlong Technologies powerRated: 125 outputVoltage: 600 minVoltage: 860 maxMPPVoltage: 1450 inverterType: 1 - id: 8651 ownerId: 5109 name: SMA Sunny Central 4200 UP_PV SYST IMPORT status: 3 lastModified: '2022-01-13T09:01:54.4' lastModifiedBy: firstName: Martin lastName: Schneider model: Sunny Central 4200 UP manufacturer: SMA powerRated: 4200 outputVoltage: 630 minVoltage: 921 maxMPPVoltage: 1325 inverterType: 2 - id: 8693 ownerId: 4876 name: Power Electronics FS4200MU CE 20201203 status: 2 lastModified: '2022-02-23T21:33:50.397' lastModifiedBy: firstName: Jason lastName: Spokes model: FS4200MU CE 20201203 manufacturer: Power Electronics powerRated: 4200 outputVoltage: 34500 minVoltage: 934 maxMPPVoltage: 1500 inverterType: 2 - id: 8728 ownerId: 5109 name: Power Electronics FS4200MU CE 20210422, temp extension status: 3 lastModified: '2024-10-24T09:45:36.183' lastModifiedBy: firstName: Andrija lastName: Marusic model: FS4200MU CE 20210422 manufacturer: Power Electronics powerRated: 4200 outputVoltage: 34500 minVoltage: 934 maxMPPVoltage: 1500 inverterType: 2 - id: 8736 ownerId: 5032 name: Huawei Technologies SUN2000-200KTL-H2 status: 3 lastModified: '2022-04-20T07:38:43.21' lastModifiedBy: firstName: Claude lastName: Deuda model: SUN2000-200KTL-H2 manufacturer: Huawei Technologies powerRated: 185 outputVoltage: 800 minVoltage: 500 maxMPPVoltage: 1500 inverterType: 1 - id: 8744 ownerId: 3927 name: imported-Power Electronics FS3190MU CE 20190927 status: 3 lastModified: '2022-03-17T04:13:27.363' lastModifiedBy: firstName: Thang lastName: Le model: imported-FS3190MU CE 20190927 manufacturer: Power Electronics powerRated: 3300 outputVoltage: 34500 minVoltage: 849 maxMPPVoltage: 1310 inverterType: 2 - id: 8956 ownerId: 5093 name: TMEIC PVU-L840GR 25C status: 2 lastModified: '2022-09-16T13:17:12.46' lastModifiedBy: firstName: Jesse lastName: Milam model: PVU-L840GR 25C manufacturer: TMEIC powerRated: 840 outputVoltage: 630 minVoltage: 915 maxMPPVoltage: 1300 inverterType: 2 - id: 9008 ownerId: 5032 name: Sungrow SG3125HV-30 status: 3 lastModified: '2022-10-13T01:56:32.4' lastModifiedBy: firstName: Carol lastName: Aber model: SG3125HV-30 manufacturer: Sungrow powerRated: 3125 outputVoltage: 600 minVoltage: 875 maxMPPVoltage: 1300 inverterType: 2 - id: 9011 ownerId: 5032 name: Huawei Technologies SUN2000-330KTL-H1-Preliminary V0.1 status: 4 lastModified: '2022-10-12T22:28:35.933' lastModifiedBy: firstName: Claude lastName: Deuda model: SUN2000-330KTL-H1-Preliminary V0.1 manufacturer: Huawei Technologies powerRated: 300 outputVoltage: 800 minVoltage: 500 maxMPPVoltage: 1500 inverterType: 2 - id: 9017 ownerId: 4876 name: Huawei Technologies SUN2000-330KTL-H1-Preliminary V0.1 status: 4 lastModified: '2023-01-23T23:50:02.017' lastModifiedBy: firstName: Jason lastName: Spokes model: SUN2000-330KTL-H1-Preliminary V0.1 manufacturer: Huawei Technologies powerRated: 300 outputVoltage: 800 minVoltage: 500 maxMPPVoltage: 1500 inverterType: 1 '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/ServerError' components: schemas: InverterOverview: type: object properties: id: type: integer ownerId: type: integer name: type: string status: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 x-enum-varnames: - Unknown - DraftPrivate - DraftShared - Active - Retired - Global - GlobalRetired description: LibraryStatusEnum lastModified: type: string description: >- ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present. lastModifiedBy: type: string model: type: string manufacturer: type: string powerRated: type: number outputVoltage: type: number minVoltage: type: number maxMPPVoltage: type: number inverterType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - Unspecified - String - Central description: InverterType responses: Unauthorized: description: >- Missing or invalid bearer token. The response body is empty and no `Content-Type` header is set; the 401 status code is the only signal. Fetch a fresh token (see the **Authentication** section of the API description) and retry. ServerError: description: | Unexpected server-side error. The body is usually a plain-text message but its structure is not guaranteed — treat it as opaque diagnostic text. Common causes: database constraint violation, downstream service timeout, internal exception. Retry-safe for idempotent requests; for non-idempotent ones, verify state before retrying. content: text/plain: schema: type: string example: An error has occurred. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Pass `Authorization: Bearer ` on every request. See the **Authentication** section of the API description for how to fetch a token. ````