> ## 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 power plant > Retrieves the power plant configuration for a prediction. Returns full PVPlant entity. **Parameters:** - `projectId` (path, required): The project ID. - `predictionId` (path, required): The prediction ID. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/PowerPlant 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: /Project/{projectId}/Prediction/{predictionId}/PowerPlant: get: tags: - PowerPlant summary: Get power plant description: > Retrieves the power plant configuration for a prediction. Returns full PVPlant entity. **Parameters:** - `projectId` (path, required): The project ID. - `predictionId` (path, required): The prediction ID. operationId: getPowerPlant parameters: - name: projectId in: path required: true schema: type: integer - name: predictionId in: path required: true schema: type: integer responses: '200': description: Power plant entity content: application/json: schema: $ref: '#/components/schemas/PowerPlant' examples: postman-powerplant: value: id: 1185523 resultList: null blocks: - name: 1 nodalExportOptions: null resultList: null arrays: - name: 1 resultList: null inverters: - name: A resultList: null dcFields: - name: 1 moduleId: 42930 module: status: 3 model: CS6W-560TB-AG 1500V manufacturer: CSI Solar Co., Ltd. length: 2278 width: 1134 weight: 32.3 defaultOrientation: 1 numberOfCellsInSeries: 72 numberOfCellsInParallel: 2 stcShortCircuitCurrent: 13.69 stcOpenCircuitVoltage: 51.40000000001521 stcmppCurrent: 13.059968913682152 stcmppVoltage: 42.97039999999989 stcMaxPower: 560 stcPowerTempCoef: -0.2978960659351747 stcShortCircuitCurrentTempCoef: 0.05040175310445581 stcOpenCircuitVoltageTempCoef: -0.25 stcEfficiency: 21.724739537606087 minTolerance: 0 maxTolerance: 1.8 cellTechnologyType: 2 constructionType: 2 faciality: 1 bifacialityFactor: 80 transmissionFactor: 0 backSideMismatch: 3 dataSource: 1 lightInducedDegradation: 1.5 moduleQuality: 0 moduleMismatchCoefficient: 1 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.56 sandiaConvectiveCoef: -0.075 cellToModuleTempDiff: 3 saturationCurrentAtSTC: 1.430522027037574e-11 seriesResistanceAtSTC: 0.205 shuntResistanceAtSTC: 7500 diodeIdealityFactorAtSTC: 1.007220280461766 exponentialDependencyOnShuntResistance: 5.5 darkShuntResistance: 30000 linearTempDependenceOnGamma: -0.026929422499999824 shortCircuitCurrentAtSTC: 13.69 recombinationParameter: 0 builtInVoltage: 0 bandgapVoltage: 1.12 linearTempDependenceOnIsc: 0.05040175310445581 heatAbsorptionCoefAlphaT: 0.9 referenceIrradiance: 1000 referenceTemperature: 25 aGamma: null bGamma: null cGamma: null dGamma: null spectralResponse: 0 pvModel: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: false sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.038242275137197 sandiaIAMB1: -0.5248112239136882 sandiaIAMB2: 0.02130703918426116 sandiaIAMB3: -0.00042240723312322523 sandiaIAMB4: 0.000004091960268471147 sandiaIAMB5: -1.5564126828688897e-8 ashraeiamB0: 0.05 spectral2B0: 0.85914 spectral2B1: -0.02088 spectral2B2: -0.0058853 spectral2B3: 0.12029 spectral2B4: 0.026814 spectral2B5: -0.001781 iamFactors: - id: 428902 incidenceAngle: 20 factor: 1 - id: 428903 incidenceAngle: 40 factor: 1 - id: 428904 incidenceAngle: 60 factor: 1 - id: 428905 incidenceAngle: 65 factor: 0.99 - id: 428906 incidenceAngle: 70 factor: 0.96 - id: 428907 incidenceAngle: 75 factor: 0.92 - id: 428908 incidenceAngle: 80 factor: 0.84 - id: 428909 incidenceAngle: 85 factor: 0.72 - id: 428910 incidenceAngle: 90 factor: 0 degradationModel: 1 linearDegradationRate: 0.5 nonLinearDegradationRates: null 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: 42930 name: CSI Solar Co., Ltd. CS6W-560TB-AG 1500V description: null companyId: 1042 company: null ownerId: 4876 owner: null createdDate: '2023-02-18T01:32:52.38' lastModified: '2023-02-18T01:34:13.8666667' lastModifiedById: 4876 lastModifiedBy: null trackingType: 1 moduleOrientation: 1 irradianceOptimization: false irradianceOptimizationType: 0 rotationSpeed: 1 nonIdealityFactor: 0.2 tablesRemovedForPCS: 0 transverseSlope: null baselineSlope: null northSouthRoadWidth: 0 eastWestRoadWidth: 6.096011996927617 modulesHigh: 1 modulesWide: 26 lateralIntermoduleGap: 0.02 verticalIntermoduleGap: 0.02 fieldLength: 358.6684981684981 fieldWidth: 99.09299999999999 collectorBandwidth: 2.278 tableLength: 29484.5 tablesPerRow: 12 postToPostSpacing: 5.694999999999999 numberOfRows: 18 tableToTableSpacing: 0 moduleAzimuth: 180 moduleTilt: 54 trackingBacktrackingType: 1 trackerPitchAngleD: 0 minimumTrackingLimitAngleD: -60 maximumTrackingLimitAngleD: 60 nightTimeStowAngleD: 0 trackerStowAngle: 0 windStowType: 0 arrayTechnologiesWindStowType: 0 windStowThreshold: null windStowAngle: null postHeight: 1.5 structureShading: 5 backSideMismatch: 3 fieldDcPower: 3134.9999999999995 modulesWiredInSeries: 26 numberOfSeriesStringsWiredInParallel: 215.31593406593404 plannedModuleRating: 560 modTempModel: 0 sandiaConductiveCoef: -3.56 sandiaConvectiveCoef: -0.075 cellToModuleTempDiff: 3 heatBalanceConductiveCoef: 29 heatBalanceConvectiveCoef: 0 nominalOperatingCellTemperature: 45 transmittanceAbsorptance: 0.9 moduleMismatchCoefficient: 1 moduleQuality: 0 lightInducedDegradation: 1.5 trackerLoadLoss: 2.028 dcWiringLossAtSTC: 1.5 dcHealth: 0 inverterIdShadeSource: null monthlySeasonalTiltFactors: [] resultList: null effectiveResistanceAtSTC: 0 totalModuleArea: 0 uiamd: null uiamg: null ushD: null ushG: null moduleSurfaceTemperatureTimeSeriesId: null moduleSurfaceTemperatureTimeSeries: null useModuleSurfaceTempTimeSeries: false trackingAngleTimeSeriesId: null trackingAngleTimeSeries: null groundCoverageRatio: 40 calculateDCFields: false shadeObjects: [] tableType: 0 shadingAlgorithm: 0 ground: edgeOffset: 50 calculate: true color: '#afaea4' slope: 0 slopeAzimuth: 180 lockModuleAzimuth: false lockModulesHigh: false lockPostHeight: false lockModulesWide: false lockNumberOfSeriesStringsWiredInParallel: false lockModulesWiredInSeries: false lockPostToPostSpacing: false lockMwAc: false lockNumberOfRows: false lockBacksideMismatch: false repeater: 1 id: 3387869 description: null inverterId: 3880 inverter: status: 5 model: '2500' manufacturer: Demo powerRated: 2500 apparentPower: 2750 minDCPowerThreshold: 5000 minVoltage: 800 maxMPPVoltage: 1450 maxAbsoluteVoltage: 1500 maxCurrent: 3508 maxElevation: 4000 outputVoltage: 550 usekVACurves: true usePQCurves: false dataSource: 1 efficiencyCurves: - id: 10567 voltage: 800 efficiencyPoints: - id: 76185 power: 245.03 efficiency: 98.01 - id: 76186 power: 493.1 efficiency: 98.62 - id: 76187 power: 740.7 efficiency: 98.76 - id: 76188 power: 1234.63 efficiency: 98.77 - id: 76189 power: 1849.69 efficiency: 98.65 - id: 76190 power: 2461.25 efficiency: 98.45 - id: 10568 voltage: 900 efficiencyPoints: - id: 76191 power: 244.6 efficiency: 97.84 - id: 76192 power: 492.35 efficiency: 98.47 - id: 76193 power: 739.73 efficiency: 98.63 - id: 76194 power: 1233.13 efficiency: 98.65 - id: 76195 power: 1847.06 efficiency: 98.51 - id: 76196 power: 2457.75 efficiency: 98.31 - id: 10569 voltage: 1200 efficiencyPoints: - id: 76197 power: 243.48 efficiency: 97.39 - id: 76198 power: 491 efficiency: 98.2 - id: 76199 power: 738.08 efficiency: 98.41 - id: 76200 power: 1230.75 efficiency: 98.46 - id: 76201 power: 1842.56 efficiency: 98.27 - id: 76202 power: 2454.75 efficiency: 98.19 kVACurves: - id: 3872 elevation: 2000 kVAPoints: - id: 21335 temperature: -35 kVA: 2750 - id: 21336 temperature: 45 kVA: 2750 - id: 21337 temperature: 50 kVA: 2500 - id: 21338 temperature: 60 kVA: 0 - id: 3873 elevation: 3000 kVAPoints: - id: 21339 temperature: -35 kVA: 2250 - id: 21340 temperature: 45 kVA: 2250 - id: 21341 temperature: 50 kVA: 2025 - id: 21342 temperature: 60 kVA: 0 - id: 3874 elevation: 4000 kVAPoints: - id: 21343 temperature: -35 kVA: 1750 - id: 21344 temperature: 45 kVA: 1750 - id: 21345 temperature: 50 kVA: 1575 - id: 21346 temperature: 60 kVA: 0 pqCurves: null inverterType: 2 id: 3880 name: 'Demo Central 2500 ' description: copied for presentation on sep 2020 companyId: 1 company: null ownerId: 742 owner: null createdDate: '2020-09-09T20:28:25.8833333' lastModified: '2020-09-15T18:28:12.46' lastModifiedById: 742 lastModifiedBy: null setpointkW: 2612.5 powerFactor: 0.95 designDerate: 0.95 kVARating: 2750 totalModuleArea: 0 derateTimeSeriesId: null derateTimeSeries: null useDerateTimeSeries: false setPointTimeSeriesId: null setPointTimeSeries: null useSetPointTimeSeries: false vmppAdjustmentTimeSeriesId: null vmppAdjustmentTimeSeries: null useVMPPTimeSeriesAdjustment: false imppAdjustmentTimeSeriesId: null imppAdjustmentTimeSeries: null useIMPPTimeSeriesAdjustment: false repeater: 1 id: 2975697 description: null acCollectionLoss: 1 dasLoad: 800 coolingLoad: 0 additionalLosses: 0 matchTotalInverterkVA: true transformerEnabled: true transformerkVARating: 2750 transformerHighSideVoltage: 34.5 transformerNoLoadLoss: 0.2 transformerFullLoadLoss: 0.7 totalModules: 0 totalModuleArea: 0 trackerMotorLosses: 0 repeater: 1 id: 2720072 description: null energizationDate: null useEnergizationDate: false numberOfModules: 0 totalModuleArea: 0 repeater: 1 id: 1538513 description: null transformers: [] transmissionLines: [] ess: null esS_Id: null exportSystem: false exportESS: false lgiaLimitTimeSeriesId: null lgiaLimitTimeSeries: null useLGIALimitTimeSeries: false powerFactor: 0.95 lgiaLimitation: null nighttimeDisconnect: false availabilityLoss: null useCoolingTemp: true desiredDCACRatio: null powerPlantDesignType: 0 customArrayConfig: null useCustomArrayConfig: false totalModuleArea: 0 maxMVTransformerVoltage: 0 maximumPlantOutput: 0 '204': description: >- No power plant has been created for this prediction yet. Response body is empty. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: schemas: PowerPlant: type: object properties: id: type: integer blocks: type: array items: $ref: '#/components/schemas/Block' transformers: type: array items: type: object transmissionLines: type: array items: type: object ess: type: - object - 'null' description: >- The Energy Storage System page allows you to configure an optional AC-coupled battery energy storage system (BESS) for your prediction. To enable energy storage, enter a Nameplate capacity value (input #1) and an Inverter Real Power rating (input #9). The Dispatch Algorithm should also be configured to ensure the... x-doc-source: docs-only:user-guide/ui/energy-storage-system.mdx esS_Id: type: - integer - 'null' exportSystem: type: - object - 'null' description: >- The 3D View provides tools for analyzing terrain and racking placement within your map-based power plant design. This interface enables terrain slope analysis, table slope constraint identification, and post height calculations. x-doc-source: docs-only:user-guide/ui/power-plant-builder-3d-view.mdx exportESS: type: boolean lgiaLimitTimeSeriesId: type: - integer - 'null' lgiaLimitTimeSeries: type: - object - 'null' description: >- The Simulation Settings page allows you to configure the prediction timeframe and select the sub-models used for irradiance calculation, module performance, shading analysis, and degradation. These settings control the algorithms applied during the energy prediction simulation. x-doc-source: docs-only:user-guide/ui/simulation-settings.mdx useLGIALimitTimeSeries: type: boolean powerFactor: type: number lgiaLimitation: type: - number - 'null' nighttimeDisconnect: type: boolean availabilityLoss: type: number useCoolingTemp: type: boolean desiredDCACRatio: type: - number - 'null' powerPlantDesignType: type: integer enum: - 0 - 1 x-enum-varnames: - Simple - Advanced description: PowerPlantDesignType customArrayConfig: type: - object - 'null' description: >- The Array page allows you to configure the medium-voltage (MV) transformer, AC collection circuit losses, and define the number of equivalent arrays within a Block. An Array aggregates multiple inverters and their associated DC Fields. Similar to the Inverter page, the Array supports a multiplier to model multiple... x-doc-source: docs-only:user-guide/ui/power-plant-builder-array.mdx useCustomArrayConfig: type: boolean totalModuleArea: type: number maxMVTransformerVoltage: type: number maximumPlantOutput: type: number resultList: type: - array - 'null' items: type: object readOnly: true Block: type: object properties: name: type: integer nodalExportOptions: {} resultList: readOnly: true arrays: type: array items: $ref: '#/components/schemas/PowerPlantArray' energizationDate: {} useEnergizationDate: type: boolean numberOfModules: type: number format: double readOnly: true totalModuleArea: type: number format: double readOnly: true repeater: type: integer id: type: integer readOnly: true description: {} PowerPlantArray: type: object properties: name: type: integer resultList: readOnly: true inverters: type: array items: $ref: '#/components/schemas/PowerPlantInverter' acCollectionLoss: type: number format: double dasLoad: type: number format: double coolingLoad: type: number format: double additionalLosses: type: number format: double matchTotalInverterkVA: type: boolean transformerEnabled: type: boolean transformerkVARating: type: number format: double transformerHighSideVoltage: type: number format: double transformerNoLoadLoss: type: number format: double transformerFullLoadLoss: type: number format: double totalModules: type: integer readOnly: true totalModuleArea: type: number format: double readOnly: true trackerMotorLosses: type: number format: double repeater: type: integer id: type: integer readOnly: true description: {} PowerPlantInverter: type: object properties: name: type: string resultList: readOnly: true dcFields: type: array items: $ref: '#/components/schemas/DCField' inverterId: type: integer inverter: type: object setpointkW: type: number format: double powerFactor: type: number format: double designDerate: type: number format: double kVARating: type: number format: double totalModuleArea: type: number format: double readOnly: true derateTimeSeriesId: {} derateTimeSeries: {} useDerateTimeSeries: type: boolean setPointTimeSeriesId: {} setPointTimeSeries: {} useSetPointTimeSeries: type: boolean vmppAdjustmentTimeSeriesId: {} vmppAdjustmentTimeSeries: {} useVMPPTimeSeriesAdjustment: type: boolean imppAdjustmentTimeSeriesId: {} imppAdjustmentTimeSeries: {} useIMPPTimeSeriesAdjustment: type: boolean repeater: type: integer id: type: integer readOnly: true description: {} DCField: type: object properties: name: type: integer moduleId: type: integer module: type: object trackingType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - FixedTilt - HorizontalTracker - SeasonalTilt description: DCFieldTrackingTypeEnum moduleOrientation: type: integer enum: - 0 - 1 x-enum-varnames: - Landscape - Portrait description: ModuleOrientation irradianceOptimization: type: boolean irradianceOptimizationType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - None - PlantPredict - ArrayTechnologies description: IrradianceOptimizationType rotationSpeed: type: number format: double nonIdealityFactor: type: number format: double tablesRemovedForPCS: type: number format: double transverseSlope: {} baselineSlope: {} northSouthRoadWidth: type: number format: double eastWestRoadWidth: type: number format: double modulesHigh: type: integer modulesWide: type: integer lateralIntermoduleGap: type: number format: double verticalIntermoduleGap: type: number format: double fieldLength: type: number format: double readOnly: true fieldWidth: type: number format: double readOnly: true collectorBandwidth: type: number format: double tableLength: type: number format: double tablesPerRow: type: number format: double postToPostSpacing: type: number format: double numberOfRows: type: number format: double tableToTableSpacing: type: number format: double moduleAzimuth: type: number format: double moduleTilt: type: number format: double trackingBacktrackingType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - TrueTracking - Backtracking - TimeSeries description: DCFieldBacktrackingType trackerPitchAngleD: type: number format: double minimumTrackingLimitAngleD: type: number format: double maximumTrackingLimitAngleD: type: number format: double nightTimeStowAngleD: type: - number - 'null' format: double trackerStowAngle: type: number format: double windStowType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - Disabled - PlantPredict - ArrayTechnologies description: WindStowType arrayTechnologiesWindStowType: type: integer enum: - 0 - 1 x-enum-varnames: - InteriorRow - ExteriorRow description: ArrayTechnologiesWindStowType windStowThreshold: {} windStowAngle: {} postHeight: type: number format: double structureShading: type: number format: double backSideMismatch: type: number format: double fieldDcPower: type: number format: double readOnly: true modulesWiredInSeries: type: integer numberOfSeriesStringsWiredInParallel: type: number format: double plannedModuleRating: type: number format: double modTempModel: type: - integer - 'null' enum: - 0 - 1 - 2 x-enum-varnames: - HeatBalance - Sandia - NOCT description: DCFieldModuleTemperatureModelType sandiaConductiveCoef: type: number format: double sandiaConvectiveCoef: type: number format: double cellToModuleTempDiff: type: number format: double heatBalanceConductiveCoef: type: number format: double heatBalanceConvectiveCoef: type: number format: double nominalOperatingCellTemperature: type: number format: double transmittanceAbsorptance: type: number format: double moduleMismatchCoefficient: type: number format: double moduleQuality: type: number format: double lightInducedDegradation: type: number format: double trackerLoadLoss: type: number format: double dcWiringLossAtSTC: type: number format: double dcHealth: type: number format: double inverterIdShadeSource: {} monthlySeasonalTiltFactors: type: array items: type: object resultList: readOnly: true effectiveResistanceAtSTC: type: number format: double readOnly: true totalModuleArea: type: number format: double readOnly: true uiamd: readOnly: true uiamg: readOnly: true ushD: readOnly: true ushG: readOnly: true moduleSurfaceTemperatureTimeSeriesId: {} moduleSurfaceTemperatureTimeSeries: {} useModuleSurfaceTempTimeSeries: type: boolean trackingAngleTimeSeriesId: {} trackingAngleTimeSeries: {} groundCoverageRatio: type: number format: double calculateDCFields: type: boolean shadeObjects: type: array items: type: object tableType: type: integer enum: - 0 - 1 x-enum-varnames: - Flat - Sloped description: TableType shadingAlgorithm: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - V2DDefault - InfiniteLengthRows - V3DDeprecated description: ShadeAlgorithm ground: type: object lockModuleAzimuth: type: boolean lockModulesHigh: type: boolean lockPostHeight: type: boolean lockModulesWide: type: boolean lockNumberOfSeriesStringsWiredInParallel: type: boolean lockModulesWiredInSeries: type: boolean lockPostToPostSpacing: type: boolean lockMwAc: type: boolean lockNumberOfRows: type: boolean lockBacksideMismatch: type: boolean repeater: type: integer id: type: integer readOnly: true description: {} 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. NotFound: description: >- The referenced resource does not exist or is not accessible to the caller. content: text/plain: schema: type: string example: Project not found. 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. ````