How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Terabase Energy

Terabase Energy Shade Engine API

The ShadeEngine API from Terabase Energy — 14 operation(s) for shadeengine.

Documentation Provider Profile APIs.io OpenAPI GitHub

Terabase Energy Shade Engine API is one of 26 APIs that Terabase Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ShadeEngine. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 17 operations across 14 paths, and defines 173 schemas. It is described by OpenAPI 3.2.0, at version current.

Requests are made against a single base URL, https://api.plantpredict.terabase.energy.

17 operations 14 paths 173 schemas 1 DELETE7 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
current
Base URL
https://api.plantpredict.terabase.energy
Authentication
API Key
Contact
PlantPredict Support
Resource Areas
1

Authentication & Security 1

Terabase Energy Shade Engine API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 7 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

ShadeEngine 17
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/ProcessingStatus
Get Shade Engine Run information
2 params → 200
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/ExportPVC
Get PVC export
2 params → 200
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Properties/{month}
Get shade engine input data from blob storage using a prediction id, with optional include of geometry (PVJ) data.
4 params → 200
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Results
Get shade engine output data from blob storage using a prediction id
3 params → 200
POST
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Results
Set shade engine output data in blob storage
2 params body → 200
POST
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Run
Trigger the shade engine to run calculation using a prediction id
3 params → 200
POST
/ShadeScene/ConvertPVCtoPVJ
Convert a PVC to PVJ using the HTTP request's query string parameters and streamed uploaded of file.
3 params body → 200
POST
/ShadeScene/ConvertSHDtoPVJ
3 params body → 200
POST
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Import/{propertiesKey}
Clones a shade scene from source to target
3 params body → 200
PUT
/Project/{projectId}/Prediction/{predictionId}/ShadeScene
This operation will update the Prediction shade scene properties without deleting any results that may exist.
2 params body → 200
DELETE
/Project/{projectId}/Prediction/{predictionId}/ShadeScene
This operation will delete the Prediction shade scene properties.
2 params → 200
PUT
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/PVJData
Used to create a new 3D Scene from the supplied PVJData
2 params body → 200
PUT
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Objects
Update objects in an existing PVJData
2 params body → 200
POST
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/InverterTranspositionFactors
This operation will set Inverter Transposition values.
2 params body → 200
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/InverterTranspositionFactors
Get a list of Inverter Transposition factors for a given prediction.
2 params → 200
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/TableRotation/Template
Used to get table rotation schedule template
2 params → 200
GET
/Project/{projectId}/Prediction/{predictionId}/ShadeScene/ShadeTableData
This operation will download the shade table in CSV format.
2 params → 200

Schemas 173

The contract defines 173 schemas that model the data the API accepts and returns. The most detailed are PlantPredict.Entities.PowerPlants.PVDCField (113 properties), PlantPredict.Entities.Module (106 properties), PlantPredict.Entities.PowerPlants.DCFieldCalculationResultDetail (71 properties), PlantPredict.Entities.Authentication.DesignProSimulationSettings (68 properties). Each schema is shown below with its type and property counts.

PlantPredict.Entities.PowerPlants.PVBlock
object
11 properties 1 required
PlantPredict.Entities.Authentication.Company
object
51 properties 1 required
PlantPredict.Entities.Authentication.CPRAPISettings
object
4 properties
PlantPredict.Entities.ShadingObject
object
4 properties
PlantPredict.Entities.Enums.MaxNumOfTablesPerColumnOptions
integer
PlantPredict.Entities.Enums.DefaultDegradation
integer
PlantPredict.Entities.Module
object
106 properties 42 required
PlantPredict.Entities.Country
object
4 properties 1 required
PlantPredict.Entities.Enums.ESSDispatchCustomCommand
integer
PlantPredict.Entities.Enums.PowerPlantDesignType
integer
PlantPredict.Entities.Types.ACCollectionSystem
object
2 properties
PlantPredict.Entities.Authentication.MeteonormAPISettings
object
1 property
PlantPredict.Entities.Enums.ArrayTechnologiesWindStowType
integer
PlantPredict.Entities.Enums.SpectralResponseEnum
integer
PlantPredict.Entities.Enums.DirectBeamShadingModel
integer
OpenTK.Mathematics.Vector3
object
14 properties
PlantPredict.Entities.DTO.MountingAnglesDTO
object
9 properties
PlantPredict.Entities.PVJData
object
14 properties
PlantPredict.Entities.Enums.InverterType
integer
PlantPredict.Entities.Enums.DCFieldBacktrackingType
integer
PlantPredict.Entities.Types.Tracking
object
6 properties
PlantPredict.Entities.UIShadeData
object
6 properties
PlantPredict.Entities.GroundObject
object
5 properties 2 required
PlantPredict.Entities.Enums.CellDesignType
integer
PlantPredict.Entities.Enums.DiffuseShadingModel
integer
PlantPredict.Entities.MetastabilityProperties
object
14 properties
PlantPredict.Entities.Authentication.ESSSettings
object
14 properties 12 required
PlantPredict.Entities.Enums.DiffuseDirectDecompModelType
integer
PlantPredict.Entities.Enums.PVCableSizes
integer
PlantPredict.Entities.ESS.ESSCalculationResultDetail
object
32 properties
PlantPredict.Entities.Authentication.SimulationSettings
object
21 properties 6 required
PlantPredict.Entities.Enums.CellTechnologyTypeEnum
integer
PlantPredict.Entities.ESS.ESSSystem
object
4 properties 1 required
PlantPredict.Entities.Types.UIAM
object
3 properties
PlantPredict.Entities.Enums.SubscriptionType
integer
PlantPredict.Entities.Enums.PVStringConductorMaterials
integer
PlantPredict.Entities.Authentication.ApplicationUserSettings
object
8 properties
PlantPredict.Entities.Enums.DCFieldTrackingTypeEnum
integer
PlantPredict.Entities.DTO.EfficiencyDetails
object
3 properties
PlantPredict.Entities.Types.kVAPoint
object
3 properties 2 required
PlantPredict.Entities.Authentication.DesignProSimulationSettings
object
68 properties 60 required
PlantPredict.Entities.Enums.TimeSeriesType
integer
PlantPredict.Entities.Enums.WeatherSourceTypeAPIEnum
integer
PlantPredict.Entities.Enums.ShadeSceneBinTypes
integer
PlantPredict.Entities.DTO.MetastabilityResultsDetail
object
9 properties
PlantPredict.Entities.Enums.ConstructionTypeEnum
integer
PlantPredict.Entities.Misc.ShadeEngine.InverterTransposition
object
2 properties
PlantPredict.Entities.PowerPlants.ArrayCalculationResultDetail
object
54 properties
PlantPredict.Entities.Authentication.ApplicationUser
object
45 properties
PlantPredict.Entities.DrawableFieldObject
object
4 properties
PlantPredict.Entities.ShadingGeometry
object
3 properties
PlantPredict.Entities.Types.GTeff
object
8 properties
PlantPredict.Entities.Enums.SoilingModelType
integer
PlantPredict.Entities.Enums.MVCableSizes
integer
PlantPredict.Entities.PowerPlants.PVArray
object
19 properties 8 required
PlantPredict.Entities.Enums.ModuleTypes
integer
PlantPredict.Entities.ShadeEngineOutputTimestamp
object
4 properties
PlantPredict.Entities.Types.EffectiveIrradianceAnalyzer
object
13 properties
PlantPredict.Entities.Enums.DCFeederConductorMaterials
integer
PlantPredict.Entities.Authentication.SystemDetailSettings
object
9 properties 8 required
PlantPredict.Entities.Authentication.DefaultSettings
object
12 properties
PlantPredict.Entities.ConfigurationSetting
object
4 properties 2 required
PlantPredict.Entities.PowerPlants.NodalExportConfiguration
object
5 properties 4 required
PlantPredict.Entities.Enums.PvModelType
integer
PlantPredict.Entities.PowerPlants.PVInverter
object
30 properties 4 required
PlantPredict.Entities.Types.ACVoltageAndCurrentAndPower
object
3 properties
PlantPredict.Entities.Types.IrradianceHorizontal
object
4 properties
PlantPredict.Entities.Enums.MVCableConductorMaterials
integer
PlantPredict.Entities.DTO.WindStowTimeSeriesResponse
object
5 properties
PlantPredict.Entities.ShadingFactor
object
2 properties
PlantPredict.Entities.Enums.UserStatusEnum
integer
PlantPredict.Entities.Enums.CompanyStatusEnum
integer
PlantPredict.Entities.Enums.DataSourceType
integer
PlantPredict.Entities.InverterShadeResult
object
4 properties
PlantPredict.Entities.Authentication.PowerPlantBuilder
object
37 properties 13 required
PlantPredict.Entities.Enums.OcpdRatings
integer
PlantPredict.Entities.Enums.SolarGISVersion
integer
PlantPredict.Entities.Authentication.WeatherAPISettings
object
5 properties
PlantPredict.Entities.Enums.TranspositionModelType
integer
PlantPredict.Entities.Authentication.SolarGISAPISettings
object
3 properties
PlantPredict.Entities.Enums.ModuleDegradationModel
integer
PlantPredict.Entities.TransmissionLine
object
5 properties 3 required
PlantPredict.Entities.SeasonalTiltMonthlyFactor
object
4 properties 2 required
PlantPredict.Entities.ShadingTable
object
7 properties
PlantPredict.Entities.Misc.ShadeEngine.SiteInverterTransposition
object
2 properties
PlantPredict.Entities.ShadedFraction
object
3 properties
PlantPredict.Entities.DTO.ShadeTranspositionFactor
object
3 properties
PlantPredict.Entities.Types.Ush
object
6 properties
PlantPredict.Entities.Transformer
object
6 properties 4 required
PlantPredict.Entities.Types.DCVoltageAndCurrentAndPower
object
10 properties
PlantPredict.Entities.Enums.CompanyTypeEnum
integer
PlantPredict.Entities.DTO.TimeSeriesDetailsDTO
object
3 properties
PlantPredict.Entities.Enums.IncidenceAngleModelType
integer
PlantPredict.Entities.Enums.ProcessingStatusEnum
integer
PlantPredict.Entities.Types.TransmissionLineOutput
object
3 properties
PlantPredict.Entities.Enums.ESSChargeAlgorithm
integer
PlantPredict.Entities.Authentication.ApplicationUserLogin
object
5 properties
PlantPredict.Entities.Types.IAMFactor
object
3 properties 2 required
PlantPredict.Entities.ShadeEngineInputData
object
2 properties
PlantPredict.Entities.PowerPlants.DCFieldCalculationResultDetail
object
71 properties
PlantPredict.Entities.EngineShadeData
object
1 property
PlantPredict.Entities.Enums.OcpdRatings_1P
integer
PlantPredict.Entities.ESS.ESSInputs
object
19 properties 16 required
PlantPredict.Entities.LaggedMovingAverages
object
3 properties
PlantPredict.Entities.PowerPlants.PowerPlantCalculationResultDetail
object
47 properties
PlantPredict.Entities.Enums.TrackerRotationModel
integer
PlantPredict.Entities.Enums.DegradationModel
integer
PlantPredict.Entities.Enums.TableType
integer
PlantPredict.Entities.Enums.PredictionStatusSettingsEnum
integer
PlantPredict.Entities.Enums.DCFieldModuleTemperatureModelType
integer
PlantPredict.Entities.Enums.SubscriptionInterval
integer
PlantPredict.Entities.Types.PQCurve
object
3 properties 1 required
PlantPredict.Entities.ShadeTableData
object
1 property
PlantPredict.Entities.Enums.AirMassModelType
integer
PlantPredict.Entities.Types.EfficiencyPoint
object
3 properties 2 required
PlantPredict.Entities.Types.PQPoint
object
3 properties
PlantPredict.Entities.Inverter
object
31 properties 9 required
PlantPredict.Entities.Enums.MapBuilderCreateDCOptions
integer
OpenTK.Mathematics.Vector2
object
6 properties
PlantPredict.Entities.Authentication.EnvironmentalConditions
object
3 properties 2 required
PlantPredict.Entities.UpdateShadingObjectsRequest
object
1 property
PlantPredict.Entities.ShadeEngineOutputData
object
6 properties
PlantPredict.Entities.TableSceneData
object
9 properties
PlantPredict.Entities.ESS.ESSDispatchCustomInfo
object
4 properties
PlantPredict.Entities.ShadingGeometryPoint
object
3 properties
PlantPredict.Entities.Enums.ModuleOrientation
integer
PlantPredict.Entities.Enums.SpectralShiftModel
integer
PlantPredict.Entities.Types.kVACurve
object
3 properties 1 required
PlantPredict.Entities.Enums.WindStowType
integer
PlantPredict.Entities.ShadeSceneProperties
object
23 properties
PlantPredict.Entities.Enums.CircumsolarTreatmentType
integer
PlantPredict.Entities.Types.TransformerOutput
object
2 properties
PlantPredict.Entities.UserWeatherDownload
object
4 properties
PlantPredict.Entities.Enums.LibraryStatusEnum
integer
PlantPredict.Entities.DTO.SunSolveBifacialTimeSeriesDetailsDTO
object
5 properties
PlantPredict.Entities.Enums.IrradianceOptimizationType
integer
PlantPredict.Entities.DCFieldObject
object
11 properties
PlantPredict.Entities.Enums.ShadeAlgorithm
integer
PlantPredict.Entities.Authentication.FinancialModelDefaultParameters
object
26 properties 25 required
PlantPredict.Entities.ESS.ESSDispatchTable
object
13 properties 12 required
PlantPredict.Entities.PowerPlants.BlockCalculationResultDetail
object
44 properties
PlantPredict.Entities.Enums.ShadeObjectType
integer
PlantPredict.Entities.Authentication.DesignProSitePlanSettings
object
10 properties 9 required
PlantPredict.Entities.DTO.ArrayWindStowResponse
object
8 properties
PlantPredict.Entities.Enums.DCFeederCableSizes
integer
System.Collections.Generic.KeyValuePair_2__System.Double__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e___System.Double__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e
object
2 properties
PlantPredict.Entities.Types.EfficiencyCurve
object
3 properties 1 required
PlantPredict.Entities.Enums.PileTypes
integer
PlantPredict.Entities.Enums.DCFieldObjectSide
integer
PlantPredict.Entities.ESS.ESSDispatchTableMonth
object
25 properties 24 required
PlantPredict.Entities.Authentication.DesignProEpcCostSettings
object
37 properties 36 required
PlantPredict.Entities.Enums.ModuleTemperatureModelType
integer
PlantPredict.Entities.Authentication.MiscellaneousSettings
object
5 properties
PlantPredict.Entities.Authentication.ApplicationRole
object
5 properties
PlantPredict.Entities.DTO.ShadeTranspositionTimeSeries
object
5 properties
PlantPredict.Entities.PowerPlants.PVDCField
object
113 properties 41 required
PlantPredict.Entities.Enums.FacialityEnum
integer
PlantPredict.Entities.ESS.ESSDispatchCustom
object
5 properties 2 required
PlantPredict.Entities.Types.InverterInputOutput
object
10 properties
PlantPredict.Entities.Types.NonLinearDegradationRate
object
3 properties
PlantPredict.Entities.PowerPlants.InverterCalculationResultDetail
object
40 properties
PlantPredict.Entities.Authentication.EngineQueueInfo
object
5 properties
PlantPredict.Entities.Enums.CollectorType
integer
PlantPredict.Entities.ShadeEngineInput
object
7 properties
PlantPredict.Entities.TimeSeries
object
7 properties
PlantPredict.Entities.Enums.InverterTypes
integer
PlantPredict.Entities.Enums.ModuleShadingResponse
integer
PlantPredict.Entities.SunSolveBifacialTimeSeries
object
5 properties
PlantPredict.Entities.Enums.CustomerSegment
integer
PlantPredict.Entities.Enums.PostHeightCalculationMethodType
integer
PlantPredict.Entities.Enums.RackingTypes
integer
PlantPredict.Entities.Authentication.ApplicationUserRole
object
4 properties
PlantPredict.Entities.PowerPlants.PVPlant
object
25 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terabase-energy-shadeengine-api-openapi.yml Raw ↑

Other APIs Terabase Energy publishes across the network.

PlantPredict MCP Connector
AE Profile APIs.io
Terrain Pro API
AE Profile APIs.io
Terabase Energy ASHRAE API
AE Profile APIs.io
Terabase Energy Company API
AE Profile APIs.io
Terabase Energy Country API
AE Profile APIs.io
Terabase Energy Definition API
AE Profile APIs.io
Terabase Energy Definitions API
AE Profile APIs.io
Terabase Energy Financial Model API
AE Profile APIs.io
Terabase Energy Home API
AE Profile APIs.io
Terabase Energy Inverter API
AE Profile APIs.io
Terabase Energy Inverters API
AE Profile APIs.io
Terabase Energy Module API
AE Profile APIs.io
#ShadeEngine
← Back to T APIs
API Details
ID
terabase-energy:terabase-energy-shadeengine-api
Base URL
https://api.plantpredict.terabase.energy
Docs
https://docs.plantpredict.com/api-docs/intro
Provider
Terabase Energy
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=terabase-energy-shadeengine-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/terabase-energy-shadeengine-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Terabase Energy Shade Engine API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.