Skip to main content
GET
/
Project
/
{projectId}
/
Prediction
/
{predictionId}
/
ResultSummary
Get prediction result summary
curl --request GET \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/ResultSummary \
  --header 'Authorization: Bearer <token>'
{
  "id": 966660,
  "predictionName": "Base Block - Small Weather",
  "runBy": "Postman Tester",
  "timeOfPrediction": "2023-10-02T19:40:22.697",
  "elapsedTimeMinutes": 0.13763712666666666,
  "execDate": "2023-10-02T19:40:22.697",
  "toolName": "PlantPredict",
  "toolVersion": "11.12.0.26953",
  "start": "2005-06-01T00:00:00",
  "end": "2005-06-04T23:00:00",
  "decompositionModel": "None",
  "transpositionModel": "Perez",
  "perezCoefficients": "PlantPredict",
  "incModel": "Physical IAM",
  "airMassModel": "Bird-Hulstrom",
  "moduleTemperatureModel": "Heat Balance",
  "degradationModel": "None",
  "circumsolarTreatment": "Diffuse",
  "directShadingModel": "Module File Defined Shading",
  "diffuseShadingModel": "Schaar-Panchula",
  "degradationRate": 0.005,
  "nonLinearDegradationRates": null,
  "lightAndElevationTemperatureDegradationRates": null,
  "spectralShiftModel": "2-Param Pwat and AM",
  "useWeatherDNI": false,
  "useMeteoPOAI": false,
  "useBacksidePOAI": false,
  "soilingModel": "Constant Monthly",
  "errorIrrAcc": 0.06480740698407861,
  "spatialVariability": 0.02,
  "interannualVariability": 0.03,
  "irradianceMeasurementAccuracy": 0.05,
  "monitoringPeriodRepresentativeness": 0.02,
  "modelingAccuracy": 0.028999999999999998,
  "errorTotal": 0.07100000000000001,
  "yearRepeater": 1,
  "projectName": "Doc Generation",
  "projectLocality": "Toledo, OH",
  "projectCountry": "United States",
  "projectLat": 41.6528052,
  "projectLon": -83.5378674,
  "projectLatLon": "41.65/-83.54",
  "projectElev": 178.5460357666016,
  "timeZone": -5,
  "weatherName": "June Weather Data - Toledo",
  "weatherGHI": 18457,
  "weatherDHI": 8245,
  "weatherDNI": 15329,
  "weatherPOA": null,
  "weatherLat": 41.6528053,
  "weatherLon": -83.5378647,
  "weatherLatLon": "41.65/-83.54",
  "weatherDataProvider": "Meteonorm",
  "inverterResultSummaries": [
    {
      "id": 980050,
      "name": "SMA Sunny Highpower SHP150-US-20-PEAK3",
      "kVARating": 150,
      "powerFactor": 1,
      "kWRating": 150,
      "usedDerateTimeSeries": false,
      "inverterEfficiencyModel": 2
    }
  ],
  "moduleResultSummaries": [
    {
      "id": 1074225,
      "name": "FS-7505A-TR1 CdTe September2022",
      "wattage": 505,
      "cellTechnologyType": "CdTe",
      "efficiency": 18.071211307926283,
      "manufacturer": "First Solar",
      "faciality": "Monofacial",
      "bifacialityFactor": 0,
      "transmissionFactor": 0
    }
  ],
  "exclEnvironmentIrrDesc": null,
  "exclEnvironmentIrrVal": null,
  "blockResultSummaries": [
    {
      "id": 1207025,
      "name": 1,
      "acSize": 1.5,
      "dcSize": 1.95,
      "numArrays": 10,
      "dcacRatio": 1.3,
      "trackingType": "Horizontal Tracker",
      "backTrackingType": "Backtracking",
      "avgTiltAngle": 0,
      "avgRotationalMax": 60,
      "avgRotationalMin": -60,
      "avgRotationalLimits": "-60.00 / 60.00",
      "avgAzimuth": 180,
      "avgRowSpacing": 5.749999999999999,
      "avgGCR": 40,
      "energizationDate": "2005-06-01T00:00:00",
      "resultDetails": [],
      "years": [
        {
          "id": 2725859,
          "year": 2005,
          "yearIndex": 1,
          "totalEnergy": 54490.73631180844,
          "transpositionOnPlane": -33.39906193172364,
          "farShadingLoss": 0,
          "nearShadingLoss": 3.415010544667114,
          "elecShadingLoss": 0,
          "soilingLoss": 2.124869768017325,
          "iamFactorLoss": 1.6377524309067946,
          "spectralLoss": -1.0148008378121767,
          "moduleIrradianceLoss": 0.6468938283773886,
          "moduleTemperatureLoss": 4.892633443721294,
          "moduleQualityLoss": 0,
          "lidLoss": 0,
          "moduleMismatchLoss": 0.4742915334455463,
          "moduleBackMismatchLoss": 0,
          "biFacialityLoss": 0,
          "structureShadingLoss": 0,
          "backSideIrradiance": 0,
          "dcWiringLoss": 0.9757620328698026,
          "dcHealthLoss": 0.9485830668910926,
          "inverterEfficiencyLoss": 1.3265712574422033,
          "inverterLimitationLoss": 3.2677104358153457,
          "degradationLoss": 0,
          "leTIDLoss": 0,
          "inverterCoolingLoss": 0,
          "trackerMotorLoss": 0.09591772994869588,
          "dataAcquisitionAuxLoss": 1.3598168239123245,
          "mvTransformersLoss": 1.067128156576251,
          "acCollectionLinesLoss": 0.988957626904007,
          "backsideEffPOA": 0,
          "summaryFactors": [
            {
              "id": 2863022,
              "blockName": 1,
              "pValue": 50,
              "pValueString": "P50",
              "ghiSum": 26.4092,
              "poAInsolation": 35.229625063672756,
              "specificYieldDC": 28.153536166240844,
              "specificYieldAC": 36.599597016113094,
              "performanceRatio": 79.91437920601527,
              "acCapacityFactor": 38.1245802251178,
              "arrayNetEnergy": 0.005489939552416965,
              "blockNetEnergy": 0.05489939552416965,
              "totalBoSLoss": 1.9834127447536236,
              "nighttimeLosses": 0.4086592123612225,
              "todFactor": -1
            }
          ]
        }
      ]
    }
  ],
  "acSize": 1.5,
  "dcSize": 1.95,
  "numArrays": 10,
  "dcacRatio": 1.3,
  "gridVoltage": 34.5,
  "trackingType": "Horizontal Tracker",
  "backTrackingType": "Backtracking",
  "avgTiltAngle": 0,
  "avgTiltAngleString": "-",
  "avgAzimuth": 180,
  "avgRowSpacing": 5.749999999999999,
  "avgGCR": 40,
  "avgRotationalMin": -60,
  "avgRotationalMax": 60,
  "avgPostHeight": 1.5,
  "avgRotationalLimits": "-60.00 / 60.00",
  "avgDCArraySize": 0.195,
  "avgACArraySize": 0.15,
  "powerFactor": 1,
  "lgiaLimitation": "Off",
  "availabilityLoss": 0,
  "years": [
    {
      "id": 2358476,
      "year": 2005,
      "yearIndex": 1,
      "totalEnergy": 54490.73631180844,
      "monthlyFactors": [
        {
          "id": 38298098,
          "month": 1,
          "monthName": "Jan",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298099,
          "month": 2,
          "monthName": "Feb",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298100,
          "month": 3,
          "monthName": "Mar",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298101,
          "month": 4,
          "monthName": "Apr",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298102,
          "month": 5,
          "monthName": "May",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298103,
          "month": 6,
          "monthName": "Jun",
          "soilingLoss": 2.2,
          "albedo": 0.3,
          "spectralShift": -1.0148008378121767
        },
        {
          "id": 38298104,
          "month": 7,
          "monthName": "Jul",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298105,
          "month": 8,
          "monthName": "Aug",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298106,
          "month": 9,
          "monthName": "Sep",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298107,
          "month": 10,
          "monthName": "Oct",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298108,
          "month": 11,
          "monthName": "Nov",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        },
        {
          "id": 38298109,
          "month": 12,
          "monthName": "Dec",
          "soilingLoss": 0,
          "albedo": 0.3,
          "spectralShift": 0
        }
      ],
      "summaryFactors": [
        {
          "id": 2459692,
          "pValue": 50,
          "pValueString": "P50",
          "ghiSum": 26.4092,
          "poAInsolation": 35.229625063672756,
          "specificYieldDC": 28.153536166240844,
          "specificYieldAC": 36.599597016113094,
          "performanceRatio": 79.91437920601527,
          "acCapacityFactor": 38.1245802251178,
          "max3hrShortCircuitCurrent": 3.0436804868598837,
          "arrayNetEnergy": 0.005489939552416965,
          "plantNetEnergy": 0.05489939552416965,
          "totalBoSLoss": 1.9834127447536236,
          "nighttimeLosses": 0.4086592123612225,
          "todFactor": -1,
          "hasESSSystem": false,
          "esspvEnergy": 0,
          "essBatteryEnergy": 0,
          "essAuxLoss": 0
        }
      ],
      "transpositionOnPlane": -33.39906193172364,
      "farShadingLoss": 0,
      "nearShadingLoss": 3.415010544667114,
      "elecShadingLoss": 0,
      "soilingLoss": 2.124869768017325,
      "iamFactorLoss": 1.6377524309067946,
      "spectralLoss": -1.0148008378121767,
      "moduleIrradianceLoss": 0.6468938283773886,
      "moduleTemperatureLoss": 4.892633443721294,
      "moduleQualityLoss": 0,
      "lidLoss": 0,
      "moduleMismatchLoss": 0.4742915334455463,
      "moduleBackMismatchLoss": 0,
      "biFacialityLoss": 0,
      "structureShadingLoss": 0,
      "backsideIrradiance": 0,
      "dcWiringLoss": 0.9757620328698026,
      "dcHealthLoss": 0.9485830668910926,
      "inverterEfficiencyLoss": 1.3265712574422033,
      "inverterLimitationLoss": 3.2677104358153457,
      "degradationLoss": 0,
      "leTIDLoss": 0,
      "inverterCoolingLoss": 0,
      "trackerMotorLoss": 0.09591772994869588,
      "dataAcquisitionAuxLoss": 1.3598168239123245,
      "mvTransformersLoss": 1.067128156576251,
      "acCollectionLinesLoss": 0.988957626904007,
      "transformerTransmissionLineLoss": [],
      "availabilityLoss": 0,
      "lgiaLimitationLoss": 0,
      "monthlySums": {
        "id": 2053402,
        "energySums": [
          {
            "id": 49281610,
            "month": 1,
            "sum": 0
          },
          {
            "id": 49281611,
            "month": 2,
            "sum": 0
          },
          {
            "id": 49281612,
            "month": 3,
            "sum": 0
          },
          {
            "id": 49281613,
            "month": 4,
            "sum": 0
          },
          {
            "id": 49281614,
            "month": 5,
            "sum": 0
          },
          {
            "id": 49281615,
            "month": 6,
            "sum": 54.89939552416966
          },
          {
            "id": 49281616,
            "month": 7,
            "sum": 0
          },
          {
            "id": 49281617,
            "month": 8,
            "sum": 0
          },
          {
            "id": 49281618,
            "month": 9,
            "sum": 0
          },
          {
            "id": 49281619,
            "month": 10,
            "sum": 0
          },
          {
            "id": 49281620,
            "month": 11,
            "sum": 0
          },
          {
            "id": 49281621,
            "month": 12,
            "sum": 0
          }
        ],
        "ghiSums": [
          {
            "id": 49281622,
            "month": 1,
            "sum": 0
          },
          {
            "id": 49281623,
            "month": 2,
            "sum": 0
          },
          {
            "id": 49281624,
            "month": 3,
            "sum": 0
          },
          {
            "id": 49281625,
            "month": 4,
            "sum": 0
          },
          {
            "id": 49281626,
            "month": 5,
            "sum": 0
          },
          {
            "id": 49281627,
            "month": 6,
            "sum": 26409.2
          },
          {
            "id": 49281628,
            "month": 7,
            "sum": 0
          },
          {
            "id": 49281629,
            "month": 8,
            "sum": 0
          },
          {
            "id": 49281630,
            "month": 9,
            "sum": 0
          },
          {
            "id": 49281631,
            "month": 10,
            "sum": 0
          },
          {
            "id": 49281632,
            "month": 11,
            "sum": 0
          },
          {
            "id": 49281633,
            "month": 12,
            "sum": 0
          }
        ]
      },
      "hasESSSystem": false,
      "essInverterEfficiencyLoss": 0,
      "essmvTransformersLoss": 0,
      "esshvacLoss": 0,
      "essdcRoundtripEfficiencyLoss": 0,
      "esspvEnergy": 0,
      "essBatteryEnergy": 0,
      "backsideEffPOA": 0,
      "reportESSDCRoundtripEfficiencyLoss": " - ",
      "reportESSHVACLoss": " - ",
      "reportESSInverterEfficiencyLoss": " - ",
      "reportESSMVTransformersLoss": " - "
    }
  ],
  "logicVersion": "Version 11",
  "predictionHasESS": false,
  "essPowerCapacity": 0,
  "essEnergyCapacity": 0,
  "hasBifacial": false,
  "useLeapYears": false,
  "useLeTID": false,
  "isDraft": false,
  "predictionYearSummary": null,
  "reportESSPowerCapacity": " - ",
  "reportESSEnergyCapacity": " - ",
  "reportTitle": null,
  "predictionStatus": null,
  "reportShowMonthlySums": false,
  "leTIDRates": null
}

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.

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

Response

Result summary

id
integer
predictionName
string
runBy
string
timeOfPrediction
string<date-time>
elapsedTimeMinutes
number
execDate
string<date-time>
toolName
string
toolVersion
string
start
string<date-time>
end
string<date-time>
decompositionModel
enum<integer>

DiffuseDirectDecompModelType

Available options:
0,
1,
2,
3
transpositionModel
enum<integer>

TranspositionModelType

Available options:
0,
1
perezCoefficients
enum<integer>

PerezCoefficientsEnum

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
incModel
enum<integer>

IncidenceAngleModelType

Available options:
2,
3,
4,
5,
6
airMassModel
enum<integer>

AirMassModelType

Available options:
0,
1
moduleTemperatureModel
enum<integer>

ModuleTemperatureModelType

Available options:
0,
1,
2,
3
degradationModel
enum<integer>

DegradationModel

Available options:
0,
1,
2,
3,
4
circumsolarTreatment
enum<integer>

CircumsolarTreatmentType

Available options:
0,
1
directShadingModel
enum<integer>

DirectBeamShadingModel

Available options:
0,
1,
2,
3,
5,
6
diffuseShadingModel
enum<integer>

DiffuseShadingModel

Available options:
0,
1