Skip to main content
POST
/
Project
/
{projectId}
/
Prediction
/
{predictionId}
/
PowerPlant
Create power plant
curl --request POST \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blocks": [
    {
      "name": 1,
      "nodalExportOptions": {
        "id": 103584,
        "exportBlock": false,
        "exportArrays": false,
        "exportInverters": false,
        "exportDCFields": true
      },
      "resultList": null,
      "arrays": [
        {
          "name": 1,
          "resultList": null,
          "inverters": [
            {
              "name": "A",
              "resultList": null,
              "dcFields": [
                {
                  "name": 1,
                  "moduleId": 40014,
                  "module": {
                    "status": 5,
                    "model": "FS-7505A-TR1 September2022",
                    "manufacturer": "First Solar",
                    "length": 2300,
                    "width": 1215,
                    "weight": 39.7,
                    "defaultOrientation": 1,
                    "numberOfCellsInSeries": 268,
                    "numberOfCellsInParallel": 1,
                    "stcShortCircuitCurrent": 3.013,
                    "stcOpenCircuitVoltage": 223.931,
                    "stcmppCurrent": 2.767,
                    "stcmppVoltage": 182.47,
                    "stcMaxPower": 505,
                    "stcPowerTempCoef": -0.32,
                    "stcShortCircuitCurrentTempCoef": 0.04,
                    "stcOpenCircuitVoltageTempCoef": -0.28,
                    "stcEfficiency": 18.071211307926283,
                    "minTolerance": 0,
                    "maxTolerance": 5,
                    "cellTechnologyType": 6,
                    "constructionType": 1,
                    "faciality": 0,
                    "bifacialityFactor": null,
                    "transmissionFactor": null,
                    "backSideMismatch": null,
                    "dataSource": 1,
                    "lightInducedDegradation": 0,
                    "moduleQuality": 0,
                    "moduleMismatchCoefficient": 0.5,
                    "heatBalanceConvectiveCoef": 0,
                    "heatBalanceConductiveCoef": 29,
                    "sandiaConductiveCoef": -3.47,
                    "sandiaConvectiveCoef": -0.0594,
                    "cellToModuleTempDiff": 3,
                    "saturationCurrentAtSTC": 4.91147e-10,
                    "seriesResistanceAtSTC": 3.885,
                    "shuntResistanceAtSTC": 11500,
                    "diodeIdealityFactorAtSTC": 1.452,
                    "exponentialDependencyOnShuntResistance": 5.5,
                    "darkShuntResistance": 12000,
                    "linearTempDependenceOnGamma": 0.01584022038567493,
                    "shortCircuitCurrentAtSTC": 3.013,
                    "recombinationParameter": 2.15,
                    "builtInVoltage": 0.9,
                    "bandgapVoltage": 1.5,
                    "linearTempDependenceOnIsc": 0.04,
                    "heatAbsorptionCoefAlphaT": 0.9,
                    "referenceIrradiance": 1000,
                    "referenceTemperature": 25,
                    "aGamma": null,
                    "bGamma": null,
                    "cGamma": null,
                    "dGamma": null,
                    "spectralResponse": 2,
                    "pvModel": 0,
                    "useDefaultSandiaIAM": false,
                    "useDefaultTabularIAM": false,
                    "sandiaSpectralA0": null,
                    "sandiaSpectralA1": null,
                    "sandiaSpectralA2": null,
                    "sandiaSpectralA3": null,
                    "sandiaSpectralA4": null,
                    "sandiaIAMB0": 6.038242275137197,
                    "sandiaIAMB1": -0.5248112239136882,
                    "sandiaIAMB2": 0.02130703918426116,
                    "sandiaIAMB3": -0.00042240723312322523,
                    "sandiaIAMB4": 0.000004091960268471147,
                    "sandiaIAMB5": -1.5564126828688897e-8,
                    "ashraeiamB0": 0.05,
                    "spectral2B0": 0.86273,
                    "spectral2B1": -0.038948,
                    "spectral2B2": -0.012506,
                    "spectral2B3": 0.098871,
                    "spectral2B4": 0.084658,
                    "spectral2B5": -0.0042948,
                    "iamFactors": null,
                    "degradationModel": 1,
                    "linearDegradationRate": 0.3,
                    "nonLinearDegradationRates": null,
                    "cellDesignType": null,
                    "powerAtSTC": 0,
                    "powerAtSTCExcludingWiringLosses": 0,
                    "effectiveIrradianceResponse": null,
                    "electricalShadingFractionalEffect": 0,
                    "moduleShadingResponse": 1,
                    "id": 40014,
                    "name": "FS-7505A-TR1 CdTe September2022",
                    "description": "S7_505_540"
                  },
                  "trackingType": 1,
                  "moduleOrientation": 1,
                  "irradianceOptimization": true,
                  "rotationSpeed": 1,
                  "nonIdealityFactor": 0.2,
                  "tablesRemovedForPCS": 0,
                  "transverseSlope": null,
                  "baselineSlope": null,
                  "northSouthRoadWidth": 6.096011996927617,
                  "eastWestRoadWidth": 6.096011996927617,
                  "modulesHigh": 1,
                  "modulesWide": 6,
                  "lateralIntermoduleGap": 0.02,
                  "verticalIntermoduleGap": 0.02,
                  "fieldLength": 54.876237623762385,
                  "fieldWidth": 42.54999999999999,
                  "collectorBandwidth": 2.3,
                  "tableLength": 7290.1,
                  "tablesPerRow": 8,
                  "postToPostSpacing": 5.749999999999999,
                  "numberOfRows": 8,
                  "tableToTableSpacing": 0,
                  "moduleAzimuth": 180,
                  "moduleTilt": 45,
                  "trackingBacktrackingType": 0,
                  "trackerPitchAngleD": 0,
                  "minimumTrackingLimitAngleD": -60,
                  "maximumTrackingLimitAngleD": 60,
                  "trackerStowAngle": 0,
                  "postHeight": 1.5,
                  "structureShading": 5,
                  "backSideMismatch": null,
                  "fieldDcPower": 180,
                  "modulesWiredInSeries": 6,
                  "numberOfSeriesStringsWiredInParallel": 59.40594059405941,
                  "plannedModuleRating": 505,
                  "modTempModel": 0,
                  "sandiaConductiveCoef": -3.47,
                  "sandiaConvectiveCoef": -0.0594,
                  "cellToModuleTempDiff": 3,
                  "heatBalanceConductiveCoef": 29,
                  "heatBalanceConvectiveCoef": 0,
                  "nominalOperatingCellTemperature": 45,
                  "transmittanceAbsorptance": 0.9,
                  "moduleMismatchCoefficient": 0.5,
                  "moduleQuality": 0,
                  "lightInducedDegradation": 0,
                  "trackerLoadLoss": 2.028,
                  "dcWiringLossAtSTC": 1.5,
                  "dcHealth": 1,
                  "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,
                  "shadeObjects": [],
                  "tableType": 1,
                  "shadingAlgorithm": 0,
                  "ground": {
                    "edgeOffset": 50,
                    "calculate": true,
                    "color": "#afaea4",
                    "slope": 2,
                    "slopeAzimuth": 180
                  },
                  "repeater": 1,
                  "description": null
                }
              ],
              "inverterId": 8238,
              "inverter": {
                "status": 5,
                "model": "Sunny Highpower SHP150-US-20-PEAK3",
                "manufacturer": "SMA",
                "powerRated": 150,
                "apparentPower": 150,
                "minDCPowerThreshold": 100,
                "minVoltage": 855,
                "maxMPPVoltage": 1450,
                "maxAbsoluteVoltage": 1500,
                "maxCurrent": 180,
                "maxElevation": 100,
                "outputVoltage": 600,
                "usekVACurves": true,
                "usePQCurves": false,
                "dataSource": 2,
                "efficiencyCurves": null,
                "kVACurves": null,
                "pqCurves": null,
                "inverterType": 1,
                "id": 8238,
                "name": "SMA Sunny Highpower SHP150-US-20-PEAK3",
                "description": null
              },
              "setpointkW": 150,
              "powerFactor": 1,
              "designDerate": 1,
              "kVARating": 150,
              "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,
              "description": null
            }
          ],
          "acCollectionLoss": 1,
          "dasLoad": 800,
          "coolingLoad": 0,
          "additionalLosses": 0,
          "matchTotalInverterkVA": true,
          "transformerEnabled": true,
          "transformerkVARating": 150,
          "transformerHighSideVoltage": 34.5,
          "transformerNoLoadLoss": 0.2,
          "transformerFullLoadLoss": 0.7,
          "totalModules": 0,
          "totalModuleArea": 0,
          "trackerMotorLosses": 0,
          "repeater": 1,
          "description": null
        }
      ],
      "energizationDate": null,
      "useEnergizationDate": false,
      "numberOfModules": 0,
      "totalModuleArea": 0,
      "repeater": 1,
      "description": null
    }
  ],
  "transformers": [],
  "transmissionLines": [],
  "ess": null,
  "exportSystem": false,
  "exportESS": false,
  "lgiaLimitTimeSeriesId": null,
  "lgiaLimitTimeSeries": null,
  "useLGIALimitTimeSeries": false,
  "powerFactor": 1,
  "lgiaLimitation": null,
  "availabilityLoss": null,
  "useCoolingTemp": true,
  "desiredDCACRatio": null,
  "powerPlantDesignType": 0,
  "customArrayConfig": null,
  "useCustomArrayConfig": false,
  "totalModuleArea": 0,
  "maxMVTransformerVoltage": 0,
  "maximumPlantOutput": 0
}
'
{
  "message": "The request is invalid.",
  "modelState": {
    "latitude": [
      "The field Latitude must be between -90 and 90."
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Path Parameters

​
projectId
integer
required
​
predictionId
integer
required

Body

application/json
​
id
integer
​
blocks
object[]
​
transformers
object[]
​
transmissionLines
object[]
​
ess
object

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...

​
esS_Id
integer | null
​
exportSystem
object

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.

​
exportESS
boolean
​
lgiaLimitTimeSeriesId
integer | null
​
lgiaLimitTimeSeries
object

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.

​
useLGIALimitTimeSeries
boolean
​
powerFactor
number
​
lgiaLimitation
number | null
​
nighttimeDisconnect
boolean
​
availabilityLoss
number
​
useCoolingTemp
boolean
​
desiredDCACRatio
number | null
​
powerPlantDesignType
enum<integer>

PowerPlantDesignType

Available options:
0,
1
​
customArrayConfig
object

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...

​
useCustomArrayConfig
boolean
​
totalModuleArea
number
​
maxMVTransformerVoltage
number
​
maximumPlantOutput
number

Response

Success