Skip to main content
GET
Get power plant

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

Power plant entity

id
integer
blocks
object[]
transformers
object[]
transmissionLines
object[]
ess
object | null

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

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

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

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
resultList
object[] | null
read-only