Terabase Energy Company API

openapi: 3.2.0
info:
  title: Terabase Energy Company API
  version: 12.13.0
  description: 'Operations tagged Company across 2 of this provider''s published API definitions: terabase-energy-company-api-openapi.yml, terabase-energy-plantpredict-openapi-original.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.plantpredict.terabase.energy
  description: Production
security:
- bearerAuth: []
tags:
- name: Company
  description: Company settings and user management
paths:
  /Company/DefaultSettings:
    get:
      tags:
      - Company
      summary: Get company default settings
      description: Returns default settings for your company.
      operationId: getCompanyDefaultSettings
      x-doc-source: postman
      responses:
        '200':
          description: Default settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  environmentalConditions:
                    type: object
                    description: The Environmental Conditions Page allows you to configure the weather and environmental parameters that influence solar resource modeling in your prediction. This includes selecting weather data, defining soiling and spectral loss profiles, setting design temperatures, and importing horizon scene data.
                    x-doc-source: inferred+docs:user-guide/ui/environmental-conditions.mdx
                    properties:
                      id:
                        type: integer
                      monthlySoilingLoss:
                        type: number
                      monthlyAlbedo:
                        type: number
                  powerPlantBuilder:
                    type: object
                    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: inferred+docs:user-guide/ui/power-plant-builder-3d-view.mdx
                    properties:
                      id:
                        type: integer
                      acCollectionLoss:
                        type: number
                      dasLoad:
                        type: number
                      coolingLoad:
                        type: number
                      transformerHighSideVoltage:
                        type: number
                      transformerNoLoadLoss:
                        type: number
                      transformerFullLoadLoss:
                        type: number
                      powerFactor:
                        type: number
                      inverter:
                        type: object
                        properties:
                          status:
                            type: integer
                          model:
                            type: string
                          manufacturer:
                            type: string
                          powerRated:
                            type: number
                          apparentPower:
                            type: number
                          minDCPowerThreshold:
                            type: number
                          minVoltage:
                            type: number
                          maxMPPVoltage:
                            type: number
                          maxAbsoluteVoltage:
                            type: number
                          maxCurrent:
                            type: number
                          maxElevation:
                            type: number
                          outputVoltage:
                            type: number
                          usekVACurves:
                            type: boolean
                          usePQCurves:
                            type: boolean
                          dataSource:
                            type: integer
                          efficiencyCurves:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          kVACurves:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          pqCurves:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          inverterType:
                            type: integer
                          id:
                            type: integer
                          name:
                            type: string
                          description:
                            type: string
                          companyId:
                            type: integer
                          company:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          ownerId:
                            type: integer
                          owner:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          createdDate:
                            type: string
                            description: ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.
                          lastModified:
                            type: string
                            description: ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.
                          lastModifiedById:
                            type: integer
                          lastModifiedBy:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                      inverter_Id:
                        type: integer
                      dcacRatio:
                        type: number
                      dcWiringLossAtSTC:
                        type: number
                      dcHealth:
                        type: number
                      trackerLoadLoss:
                        type: number
                      minimumTrackingLimitAngleD:
                        type: number
                      maximumTrackingLimitAngleD:
                        type: number
                      structureShading:
                        type: number
                      module_Id:
                        type: integer
                      module:
                        type: object
                        properties:
                          status:
                            type: integer
                          model:
                            type: string
                          manufacturer:
                            type: string
                          length:
                            type: number
                          width:
                            type: number
                          weight:
                            type: number
                          defaultOrientation:
                            type: integer
                          numberOfCellsInSeries:
                            type: integer
                          numberOfCellsInParallel:
                            type: integer
                          stcShortCircuitCurrent:
                            type: number
                          stcOpenCircuitVoltage:
                            type: number
                          stcmppCurrent:
                            type: number
                          stcmppVoltage:
                            type: number
                          stcMaxPower:
                            type: number
                          stcPowerTempCoef:
                            type: number
                          stcShortCircuitCurrentTempCoef:
                            type: number
                          stcOpenCircuitVoltageTempCoef:
                            type: number
                          stcEfficiency:
                            type: number
                          minTolerance:
                            type: number
                          maxTolerance:
                            type: number
                          cellTechnologyType:
                            type: integer
                          constructionType:
                            type: integer
                          faciality:
                            type: integer
                          bifacialityFactor:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          transmissionFactor:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          backSideMismatch:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          dataSource:
                            type: integer
                          lightInducedDegradation:
                            type: number
                          moduleQuality:
                            type: number
                          moduleMismatchCoefficient:
                            type: number
                          heatBalanceConvectiveCoef:
                            type: number
                          heatBalanceConductiveCoef:
                            type: number
                          sandiaConductiveCoef:
                            type: number
                          sandiaConvectiveCoef:
                            type: number
                          cellToModuleTempDiff:
                            type: number
                          saturationCurrentAtSTC:
                            type: number
                          seriesResistanceAtSTC:
                            type: number
                          shuntResistanceAtSTC:
                            type: number
                          diodeIdealityFactorAtSTC:
                            type: number
                          exponentialDependencyOnShuntResistance:
                            type: number
                          darkShuntResistance:
                            type: number
                          linearTempDependenceOnGamma:
                            type: number
                          shortCircuitCurrentAtSTC:
                            type: number
                          recombinationParameter:
                            type: number
                          builtInVoltage:
                            type: number
                          bandgapVoltage:
                            type: number
                          linearTempDependenceOnIsc:
                            type: number
                          heatAbsorptionCoefAlphaT:
                            type: number
                          referenceIrradiance:
                            type: number
                          referenceTemperature:
                            type: number
                          aGamma:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          bGamma:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          cGamma:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          dGamma:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          spectralResponse:
                            type: integer
                          pvModel:
                            type: integer
                          useDefaultSandiaIAM:
                            type: boolean
                          useDefaultTabularIAM:
                            type: boolean
                          sandiaSpectralA0:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          sandiaSpectralA1:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          sandiaSpectralA2:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          sandiaSpectralA3:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          sandiaSpectralA4:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          sandiaIAMB0:
                            type: number
                          sandiaIAMB1:
                            type: number
                          sandiaIAMB2:
                            type: number
                          sandiaIAMB3:
                            type: number
                          sandiaIAMB4:
                            type: number
                          sandiaIAMB5:
                            type: number
                          ashraeiamB0:
                            type: number
                          spectral2B0:
                            type: number
                          spectral2B1:
                            type: number
                          spectral2B2:
                            type: number
                          spectral2B3:
                            type: number
                          spectral2B4:
                            type: number
                          spectral2B5:
                            type: number
                          iamFactors:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          degradationModel:
                            type: integer
                          linearDegradationRate:
                            type: number
                          nonLinearDegradationRates:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          cellDesignType:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          useAntiReflectiveCoating:
                            type: boolean
                          refractiveIndex:
                            type: number
                          refractiveIndexOfARC:
                            type: number
                          glazingExtinctionCoef:
                            type: number
                          glazingThickness:
                            type: number
                          powerAtSTC:
                            type: number
                          powerAtSTCExcludingWiringLosses:
                            type: number
                          effectiveIrradianceResponse:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          electricalShadingFractionalEffect:
                            type: number
                          moduleShadingResponse:
                            type: integer
                          isMetastable:
                            type: boolean
                          metastabilityProperties:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          id:
                            type: integer
                          name:
                            type: string
                          description:
                            type: string
                          companyId:
                            type: integer
                          company:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          ownerId:
                            type: integer
                          owner:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          createdDate:
                            type: string
                            description: ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.
                          lastModified:
                            type: string
                            description: ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.
                          lastModifiedById:
                            type: integer
                          lastModifiedBy:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                      dcFieldTrackingTypeEnum:
                        type: integer
                      tiltAngle:
                        type: number
                      gcr:
                        type: number
                      northernHemisphereAzimuth:
                        type: number
                      southernHemisphereAzimuth:
                        type: number
                      azimuth:
                        type: number
                      irradianceOptimization:
                        type: boolean
                      irradianceOptimizationType:
                        type: integer
                      rotationSpeed:
                        type: number
                      nonIdealityFactor:
                        type: number
                      postHeightCalculationMethod:
                        type: integer
                      postHeight:
                        type: number
                      modTempModel:
                        type: integer
                      mapBuilderCreateDCAs:
                        type: integer
                      shadingAlgorithm:
                        type: integer
                      setback:
                        type: number
                      northSouthRoadWidth:
                        type: number
                      eastWestRoadWidth:
                        type: number
                  simulationSettings:
                    type: object
                    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: inferred+docs:user-guide/ui/simulation-settings.mdx
                    properties:
                      id:
                        type: integer
                      errorModelAcc:
                        type: number
                      errorSensAcc:
                        type: number
                      errorIntAnnVar:
                        type: number
                      errorMonAcc:
                        type: number
                      errorSpaVar:
                        type: number
                      transpositionModel:
                        type: integer
                      diffuseDirectDecompModel:
                        type: integer
                      useMeteoDni:
                        type: boolean
                      airMassModel:
                        type: integer
                      soilingModel:
                        type: integer
                      modTempModel:
                        type: integer
                      spectralShiftModel:
                        type: integer
                      incAngleModel:
                        type: integer
                      directBeamShadingModel:
                        type: integer
                      degradationModel:
                        type: integer
                      diffuseShadingModel:
                        type: integer
                      defaultDegradation:
                        type: integer
                      circumsolarTreatment:
                        type: integer
                      linearDegradationRate:
                        type: number
                      firstYearDegradation:
                        type: boolean
                  weatherAPISettings:
                    type: object
                    description: 'The Add New Weather page provides three methods for adding weather data to PlantPredict:'
                    x-doc-source: inferred+docs:user-guide/ui/add-new-weather.mdx
                    properties:
                      id:
                        type: integer
                      meteonormSettings:
                        type: object
                        properties:
                          key:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                      cprSettings:
                        type: object
                        properties:
                          apiKey:
                            type: string
                          userName:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          password:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                          licenseNumber:
                            description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                      solarGISSettings:
                        type: object
                        properties:
                          key:
                            type: string
                          tmyKey:
                            type: string
                          version:
                            type: integer
                      arrayTechnologiesAPIKey:
                        type: string
                  essSettings:
                    type: object
                    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: inferred+docs:user-guide/ui/energy-storage-system.mdx
                    properties:
                      id:
                        type: integer
                      factor:
                        type: number
                      usableEnergyCapacityCalendarDeg:
                        type: number
                      usableEnergyCapacityCycleDeg:
                        type: number
                      roundtripDCEfficiencyYear1:
                        type: number
                      roundtripDCEfficiencyCalendarDeg:
                        type: number
                      roundtripDCEfficiencyCycleDeg:
                        type: number
                      hvacNoLoadLoss:
                        type: number
                      hvacFullLoadLoss:
                        type: number
                      mvNoLoadLoss:
                        type: number
                      mvFullLoadLoss:
                        type: number
                      mvCapacity:
                        description: Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.
                      inverterEfficiency:
                        type: number
                      chargeAlgorithm:
                        type: integer
                  financialModelParameters:
                    type: object
                    x-doc-source: inferred
                    properties:
                      id:
                        type: integer
                      bosInput:
                        type: number
                      developmentCostPerWatt:
                        type: number
                      moduleCostPerWatt:
                        type: number
                      itcPercentage:
                        type: number
                      yearOneEnergyAdjustmentPercentage:
                        type: number
                      ppaPrice:
                        type: number
                      ppaEscalatorPercentage:
                        type: number
                      omYearOne:
                        type: number
                      omYearlyEscalatorPercentage:
                        type: number
                      ppaDuration:
                        type: integer
                      postPPAPrice:
                        type: number
                      postPPAPriceEscalationPercentage:
                        type: number
                      projectLife:
                        type: integer
                      discountNPVPercentage:
                        type: number
                      itcEligibilityPercentage:
                        type: number
                      solarSalvageValuePercentage:
                        type: number
                      insuranceCapitalCostPercentage:
                        type: number
                      insuranceEscalatorPerYearPercentage:
                        type: number
                      bonusDepreciationRate:
                        type: number
                      stateTaxRate:
                        type: number
                      federalTaxRate:
                        type: number
                      solarLandLeaseCost:
                        type: number
                      solarLandLeaseEscalationPercentage:
                        type: number
                      solarPropertyTaxCost:
                        type: number
                      solarPropertyTaxEscalationPercentage:
                        type: number
                  miscellaneousSettings:
                    type: object
                    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: inferred+docs:user-guide/ui/simulation-settings.mdx
                    properties:
                      id:
                        type: integer
                      predictionStatus:
                        type: integer
                      weatherStatus:
                        type: integer
                      inverterStatus:
                        type: integer
                      moduleStatus:
                        type: integer
                  devPlatformSimulationSettings:
                    type: object
                  devPlatformSitePlanSettings:
                    type: object
              examples:
                postman-default-settings:
                  value:
                    id: 67
                    environmentalConditions:
                      id: 190
                      monthlySoilingLoss: 2
                      monthlyAlbedo: 0.2
                    powerPlantBuilder:
                      acCollectionLoss: 1
                      dasLoad: 800
                      coolingLoad: 0
                      transformerHighSideVoltage: 34.5
                      transformerNoLoadLoss: 0.2
                      transformerFullLoadLoss: 0.7
                      powerFactor: 1
                      inverter_Id: 8279
                      dcacRatio: 1.2
                      dcWiringLossAtSTC: 1.5
                      dcHealth: 1
                      trackerLoadLoss: 2.028
                      minimumTrackingLimitAngleD: -60
                      maximumTrackingLimitAngleD: 60
                      structureShading: 5
                      module_Id: 224
                      dcFieldTrackingTypeEnum: 1
                      dcFieldBacktrackingType: 1
                      tiltAngle: null
                      gcr: 40
                      moduleOrientation: 1
                      azimuth: 180
                      modTempModel: 0
                      setback: 6.5
                      northSouthRoadWidth: 6.096011996927617
                      eastWestRoadWidth: 6.096011996927617
                    simulationSettings:
                      errorModelAcc: 2.9
                      errorSensAcc: 5
                      errorIntAnnVar: 3
                      errorMonAcc: 2
                      errorSpaVar: 2
                      transpositionModel: 1
                      diffuseDirectDecompModel: 3
                      useMeteoDni: false
                      airMassModel: 0
                      soilingModel: 0
                      modTempModel: 0
                      spectralShiftModel: 2
                      incAngleModel: 5
                      directBeamShadingModel: 5
                      degradationModel: 0
                      diffuseShadingModel: 1
                      defaultDegradation: 0
         

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/terabase-energy/refs/heads/main/openapi/terabase-energy-company-api-openapi.yml