> ## 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. # List all accessible modules > Gets all available modules and their corresponding properties. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Module 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: /Module: get: tags: - Modules summary: List all accessible modules description: Gets all available modules and their corresponding properties. operationId: listModules responses: '200': description: Array of modules content: application/json: schema: type: array items: $ref: '#/components/schemas/Module' examples: postman-module: value: - status: 6 model: FS-372 manufacturer: First Solar length: 1200 width: 600 weight: 12 defaultOrientation: 0 numberOfCellsInSeries: 77 numberOfCellsInParallel: 2 stcShortCircuitCurrent: 1.75 stcOpenCircuitVoltage: 61.4 stcmppCurrent: 1.46 stcmppVoltage: 49.5 stcMaxPower: 72.5 stcPowerTempCoef: -0.25 stcShortCircuitCurrentTempCoef: 0.04 stcOpenCircuitVoltageTempCoef: -0.27 stcEfficiency: 10.07 minTolerance: -5 maxTolerance: 5 cellTechnologyType: 6 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: 0 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 30.7 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 1.564e-7 seriesResistanceAtSTC: 2.85 shuntResistanceAtSTC: 3250 diodeIdealityFactorAtSTC: 1.925 exponentialDependencyOnShuntResistance: 3 darkShuntResistance: 18250 linearTempDependenceOnGamma: 0.17195 shortCircuitCurrentAtSTC: 1.75 recombinationParameter: 0.8 builtInVoltage: 0.9 bandgapVoltage: 1.5 linearTempDependenceOnIsc: 0.04 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 1 pvModel: 0 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: 0.79418 spectral2B1: -0.049883 spectral2B2: -0.013402 spectral2B3: 0.16766 spectral2B4: 0.083377 spectral2B5: -0.0044007 iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 11 name: FS-372 CdTe Q310 description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:07.38' lastModified: '2022-10-17T15:29:17.123' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 8e944254-dc5f-4be7-a0b2-8ca729ccd4b0 - status: 6 model: SF140-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.1 stcOpenCircuitVoltage: 107 stcmppCurrent: 1.74 stcmppVoltage: 80.5 stcMaxPower: 140 stcPowerTempCoef: -0.313 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.29 stcEfficiency: 11.4 minTolerance: 0 maxTolerance: 3.6 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 2.7153e-7 seriesResistanceAtSTC: 5.5 shuntResistanceAtSTC: 380 diodeIdealityFactorAtSTC: 1.558 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 2600 linearTempDependenceOnGamma: 0.06868 shortCircuitCurrentAtSTC: 2.1 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 12 name: SolarFrontier SF140 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:07.52' lastModified: '2017-01-27T18:22:55.577' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 445d1ef9-6c25-43d6-ba39-9e8ff7343652 - status: 6 model: SF145-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.2 stcOpenCircuitVoltage: 107 stcmppCurrent: 1.8 stcmppVoltage: 81 stcMaxPower: 145 stcPowerTempCoef: -0.313 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.3 stcEfficiency: 11.81 minTolerance: 0 maxTolerance: 3.5 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 2.7581e-7 seriesResistanceAtSTC: 5.9 shuntResistanceAtSTC: 400 diodeIdealityFactorAtSTC: 1.553 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 2600 linearTempDependenceOnGamma: 0.07534 shortCircuitCurrentAtSTC: 2.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 13 name: SolarFrontier SF145 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:07.653' lastModified: '2017-01-27T18:22:55.637' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 47d0c56d-0f5c-43c5-81c4-a9fe8bbad845 - status: 6 model: SF150-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.2 stcOpenCircuitVoltage: 108 stcmppCurrent: 1.85 stcmppVoltage: 81.5 stcMaxPower: 150 stcPowerTempCoef: -0.312 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.3 stcEfficiency: 12.21 minTolerance: 0 maxTolerance: 3.3 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 1.3368e-7 seriesResistanceAtSTC: 5.9 shuntResistanceAtSTC: 480 diodeIdealityFactorAtSTC: 1.497 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 3250 linearTempDependenceOnGamma: 0.06814 shortCircuitCurrentAtSTC: 2.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 14 name: SolarFrontier SF150 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:07.777' lastModified: '2017-01-27T18:22:55.653' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 5f97440c-cf80-41bb-9a50-11e155cb2b2f - status: 6 model: SF155-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.2 stcOpenCircuitVoltage: 109 stcmppCurrent: 1.88 stcmppVoltage: 82.5 stcMaxPower: 155 stcPowerTempCoef: -0.312 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.3 stcEfficiency: 12.62 minTolerance: 0 maxTolerance: 3.2 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 2.1064e-7 seriesResistanceAtSTC: 5 shuntResistanceAtSTC: 510 diodeIdealityFactorAtSTC: 1.553 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 4250 linearTempDependenceOnGamma: 0.0631 shortCircuitCurrentAtSTC: 2.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 15 name: SolarFrontier SF155 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:07.917' lastModified: '2017-01-27T18:22:55.67' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 123a5d58-d3e0-41ca-9fe7-7f5cbe0c7f02 - status: 6 model: SF160-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.2 stcOpenCircuitVoltage: 110 stcmppCurrent: 1.91 stcmppVoltage: 84 stcMaxPower: 160 stcPowerTempCoef: -0.311 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.3 stcEfficiency: 13.03 minTolerance: 0 maxTolerance: 3.1 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 1.351e-7 seriesResistanceAtSTC: 4.3 shuntResistanceAtSTC: 550 diodeIdealityFactorAtSTC: 1.525 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 5000 linearTempDependenceOnGamma: 0.0518 shortCircuitCurrentAtSTC: 2.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 16 name: SolarFrontier SF160 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:08.043' lastModified: '2017-01-27T18:22:55.687' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: e105223d-1691-4105-adc3-eb53e56fa3cb - status: 6 model: SF165-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.2 stcOpenCircuitVoltage: 110 stcmppCurrent: 1.93 stcmppVoltage: 85.5 stcMaxPower: 165 stcPowerTempCoef: -0.311 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.3 stcEfficiency: 13.44 minTolerance: 0 maxTolerance: 3 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 2.926e-8 seriesResistanceAtSTC: 4 shuntResistanceAtSTC: 600 diodeIdealityFactorAtSTC: 1.395 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 5300 linearTempDependenceOnGamma: 0.04014 shortCircuitCurrentAtSTC: 2.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 17 name: SolarFrontier SF165 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:08.187' lastModified: '2017-01-27T18:22:55.703' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 28b32a98-ce60-45ea-aea2-be3e97cf7d8c - status: 6 model: SF170-S manufacturer: Solar Frontier K. K. length: 1257 width: 977 weight: 20 defaultOrientation: 1 numberOfCellsInSeries: 170 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 2.2 stcOpenCircuitVoltage: 112 stcmppCurrent: 1.95 stcmppVoltage: 87.5 stcMaxPower: 170 stcPowerTempCoef: -0.311 stcShortCircuitCurrentTempCoef: 0.01 stcOpenCircuitVoltageTempCoef: -0.244 stcEfficiency: 13.84 minTolerance: 0 maxTolerance: 2.9 cellTechnologyType: 7 constructionType: 1 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: -2 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.47 sandiaConvectiveCoef: -0.0594 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 7.57e-9 seriesResistanceAtSTC: 4 shuntResistanceAtSTC: 630 diodeIdealityFactorAtSTC: 1.322 exponentialDependencyOnShuntResistance: 3.1 darkShuntResistance: 5850 linearTempDependenceOnGamma: 0.02118 shortCircuitCurrentAtSTC: 2.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.03 linearTempDependenceOnIsc: 0.01 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: null spectral2B1: null spectral2B2: null spectral2B3: null spectral2B4: null spectral2B5: null iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 2 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 0 moduleShadingResponse: 1 isMetastable: false metastabilityProperties: null id: 18 name: SolarFrontier SF170 S description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:08.393' lastModified: '2017-01-27T18:22:55.723' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 00a97948-92c9-409e-832f-988d424b066b - status: 6 model: SPR-X20-250-BLK manufacturer: SunPower length: 1559 width: 798 weight: 15 defaultOrientation: 1 numberOfCellsInSeries: 72 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 6.2 stcOpenCircuitVoltage: 50.9 stcmppCurrent: 5.84 stcmppVoltage: 42.8 stcMaxPower: 250 stcPowerTempCoef: -0.3 stcShortCircuitCurrentTempCoef: 0.037 stcOpenCircuitVoltageTempCoef: -0.247 stcEfficiency: 20.1 minTolerance: 0 maxTolerance: 5 cellTechnologyType: 1 constructionType: 2 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: 0 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.56 sandiaConvectiveCoef: -0.075 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 1.4e-9 seriesResistanceAtSTC: 0.3 shuntResistanceAtSTC: 2583 diodeIdealityFactorAtSTC: 1.188 exponentialDependencyOnShuntResistance: 5.5 darkShuntResistance: 10500 linearTempDependenceOnGamma: 0.00084 shortCircuitCurrentAtSTC: 6.2 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.12 linearTempDependenceOnIsc: 0.037 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: false sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: 0.85914 spectral2B1: -0.02088 spectral2B2: -0.0058853 spectral2B3: 0.12029 spectral2B4: 0.026814 spectral2B5: -0.001781 iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 0 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 100 moduleShadingResponse: 2 isMetastable: false metastabilityProperties: null id: 19 name: Sunpower SPR X20 250 BLK description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:08.517' lastModified: '2016-06-01T16:03:08.517' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: c935c232-d143-43d0-8177-85ad95f4487c - status: 6 model: SPR-300-WHT-I manufacturer: SunPower length: 1559 width: 1046 weight: 24 defaultOrientation: 1 numberOfCellsInSeries: 96 numberOfCellsInParallel: 1 stcShortCircuitCurrent: 5.87 stcOpenCircuitVoltage: 64 stcmppCurrent: 5.49 stcmppVoltage: 54.7 stcMaxPower: 300 stcPowerTempCoef: -0.38 stcShortCircuitCurrentTempCoef: 0.06 stcOpenCircuitVoltageTempCoef: -0.276 stcEfficiency: 18.4 minTolerance: -3 maxTolerance: 3 cellTechnologyType: 1 constructionType: 2 faciality: 0 bifacialityFactor: null transmissionFactor: null backSideMismatch: null dataSource: 1 lightInducedDegradation: 0 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.56 sandiaConvectiveCoef: -0.075 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 1.1e-11 seriesResistanceAtSTC: 0.497 shuntResistanceAtSTC: 3554 diodeIdealityFactorAtSTC: 0.96 exponentialDependencyOnShuntResistance: 5.5 darkShuntResistance: 14000 linearTempDependenceOnGamma: -0.06667 shortCircuitCurrentAtSTC: 5.87 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.12 linearTempDependenceOnIsc: 0.06 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: 0 bGamma: 0 cGamma: 0 dGamma: 0 spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: true sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.03824227511895 sandiaIAMB1: -0.524811223911995 sandiaIAMB2: 0.0213070391842001 sandiaIAMB3: -0.000422407233122155 sandiaIAMB4: 0.000004091960268462 sandiaIAMB5: -1.55641268286583e-8 ashraeiamB0: 0.05 spectral2B0: 0.85914 spectral2B1: -0.02088 spectral2B2: -0.0058853 spectral2B3: 0.12029 spectral2B4: 0.026814 spectral2B5: -0.001781 iamFactors: null degradationModel: 0 linearDegradationRate: 0 nonLinearDegradationRates: [] cellDesignType: 0 useAntiReflectiveCoating: false refractiveIndex: 1.526 refractiveIndexOfARC: 1.29 glazingExtinctionCoef: 4 glazingThickness: 0.002 powerAtSTC: 0 powerAtSTCExcludingWiringLosses: 0 effectiveIrradianceResponse: null electricalShadingFractionalEffect: 100 moduleShadingResponse: 2 isMetastable: false metastabilityProperties: null id: 20 name: Sunpower SPR300WHTI description: null companyId: 1 company: null ownerId: 742 owner: null createdDate: '2016-06-01T16:03:08.643' lastModified: '2016-06-01T16:03:08.643' lastModifiedById: 742 lastModifiedBy: company: null companyId: 1 firstName: System lastName: Account jobTitle: System createdByUserId: null createdByUser: null status: 0 createdDateUtc: '2016-09-01T00:00:00' settings: null costCenter: null migrationAgreementAcceptance: true clientCredentialsCreatedOnUTC: null uuid: null userWeatherDownloads: null lastLoginDateUTC: null roles: [] logins: [] id: 742 normalizedUserName: null email: FS108328@FIRSTSOLAR.COM normalizedEmail: null concurrencyStamp: 53813ca7-18a6-4014-8fbf-c39a33453452 '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/ServerError' components: schemas: Module: type: object required: - name - manufacturer - model - stcMaxPower properties: id: type: integer readOnly: true name: type: string description: type: - string - 'null' status: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 x-enum-varnames: - Unknown - DraftPrivate - DraftShared - Active - Retired - Global - GlobalRetired description: LibraryStatusEnum model: type: string manufacturer: type: string length: type: number description: mm width: type: number description: mm weight: type: number description: kg defaultOrientation: type: integer enum: - 0 - 1 x-enum-varnames: - Landscape - Portrait description: ModuleOrientation numberOfCellsInSeries: type: integer numberOfCellsInParallel: type: integer stcShortCircuitCurrent: type: number stcOpenCircuitVoltage: type: number stcmppCurrent: type: number stcmppVoltage: type: number stcMaxPower: type: number description: Wp stcPowerTempCoef: type: number stcShortCircuitCurrentTempCoef: type: number stcOpenCircuitVoltageTempCoef: type: number stcEfficiency: type: number minTolerance: type: number maxTolerance: type: number cellTechnologyType: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 x-enum-varnames: - NTypeMonoCSi - PTypeMonoCSiPERC - PTypeMonoCSiBSF - PolyCSiPERC - PolyCSiBSF - CdTe - CIGS - Mixed description: CellTechnologyTypeEnum cellDesignType: type: integer enum: - 0 - 1 - 2 - 3 x-enum-varnames: - FullCellTechnology - HalfCellTechnology - NA - NoneSpecified description: CellDesignType constructionType: type: integer enum: - 1 - 2 x-enum-varnames: - GlassGlass - GlassBacksheet description: ConstructionTypeEnum faciality: type: integer enum: - 0 - 1 x-enum-varnames: - Monofacial - Bifacial description: FacialityEnum bifacialityFactor: type: - number - 'null' transmissionFactor: type: - number - 'null' backSideMismatch: type: - number - 'null' dataSource: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 x-enum-varnames: - Manufacturer - PVsyst - UniversityOfGeneva - Photon - SandiaDatabase - Custom - PlantPredict description: DataSourceType lightInducedDegradation: type: number moduleQuality: type: number moduleMismatchCoefficient: type: number heatBalanceConvectiveCoef: type: number heatBalanceConductiveCoef: type: number sandiaConductiveCoef: type: number sandiaConvectiveCoef: type: number cellToModuleTempDiff: type: number pvModel: type: integer enum: - 0 - 1 - 3 x-enum-varnames: - V1DiodeRecombination - V1Diode - V1DiodeRecombinationNonLinearTemp description: PvModelType referenceIrradiance: type: number referenceTemperature: type: number degradationModel: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - Unspecified - Linear - NonLinear description: ModuleDegradationModel linearDegradationRate: type: number effectiveIrradianceResponse: type: - array - 'null' items: type: object iamFactors: type: - array - 'null' items: type: object nonLinearDegradationRates: type: array items: type: object 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. ````