Yield
query Parameters
latitudeLatitude in decimal degrees
longitudeLongitude in decimal degrees
slopeModule tilt angle in degrees (0=horizontal, 90=vertical)
orientationModule azimuth in degrees (0=North, 90=East, 180=South, 270=West)
elevationElevation in meters above sea level. -999 = auto-detect from terrain model
temperature_coefficient_powerTemperature coefficient of power in %/°C
mounting_typeMounting type: 'open' (free-standing), 'mix' (partially ventilated), 'isol' (building-integrated)
panel_age_yearsAge of the PV panels in years
ground_albedoGround reflectance (albedo)
cable_loss_rateDC cable loss rate as fraction (e.g. 0.015 = 1.5%)
conversion_loss_rateInverter/conversion loss rate as fraction
ground_coverage_ratioGround coverage ratio for row self-shading (0=no rows, 1=fully covered)
tracker_system_typeTracker type: 0=fixed, 1=single-axis, 2=dual-axis
single_axis_tracker_configSingle-axis tracker config string (axis_azimuth:axis_tilt:max_angle:backtracking)
sky_obstruction_configSky obstruction config string (azimuth_start:azimuth_end:elevation pairs)
terrain_based_horizon_coverageUse terrain-based horizon coverage from elevation model
installation_heightInstallation height above ground in meters
shading_configNear-field shading config string (matrix format)
pv_power_kwPV system peak power in kW
second_array_slopeSecond array tilt angle in degrees
second_array_orientationSecond array azimuth in degrees
second_array_ground_coverage_ratioSecond array ground coverage ratio
second_array_shading_configSecond array shading config string
second_array_power_kwSecond array peak power in kW
pv_technology_typePV cell technology type
diffuse_radiation_modelDiffuse radiation transposition model
detailed_lossesReturn detailed loss breakdown
inverter_clip_max_threshold_percentInverter clipping max threshold in % of nominal power
inverter_clip_min_threshold_percentInverter clipping min threshold in % of nominal power
snow_slide_coefficientSnow slide coefficient (0=no sliding, 1=very fast slide-off)
enable_soiling_modelEnable soiling loss model
soiling_model_configSoiling model config string (cleaning_threshold_hours:cleaning_threshold:v_25:v_10)
Headers
AuthorizationBearer token. Format: Bearer YOUR_API_KEY
Yield › Responses
Successful Response
System
query Parameters
latitudeLatitude in decimal degrees
longitudeLongitude in decimal degrees
slopeModule tilt angle in degrees (0=horizontal, 90=vertical)
orientationModule azimuth in degrees (0=North, 90=East, 180=South, 270=West)
pv_power_kwPV system peak power in kW
yearly_energy_consumptionYearly household energy consumption in MWh
yearly_heat_pump_consumptionYearly heat pump energy consumption in MWh
yearly_base_consumptionYearly base load consumption in MWh
battery_capacityBattery storage capacity in kWh
elevationElevation in meters above sea level. -999 = auto-detect from terrain model
air_cool_configAir cooling monthly config: string of 12 digits (0 or 1), one per month
air_cool_temperature_thresholdAir cooling activation temperature in °C
air_cool_peak_powerAir cooling peak power in kW
charge_power_ratioBattery charge power ratio (C-rate)
discharge_power_ratioBattery discharge power ratio (C-rate)
battery_efficiencyRound-trip battery efficiency
demand_profileLoad demand profile type
temperature_coefficient_powerTemperature coefficient of power in %/°C
mounting_typeMounting type: 'open' (free-standing), 'mix' (partially ventilated), 'isol' (building-integrated)
panel_age_yearsAge of the PV panels in years
ground_albedoGround reflectance (albedo)
cable_loss_rateDC cable loss rate as fraction (e.g. 0.015 = 1.5%)
conversion_loss_rateInverter/conversion loss rate as fraction
ground_coverage_ratioGround coverage ratio for row self-shading (0=no rows, 1=fully covered)
tracker_system_typeTracker type: 0=fixed, 1=single-axis, 2=dual-axis
single_axis_tracker_configSingle-axis tracker config string (axis_azimuth:axis_tilt:max_angle:backtracking)
sky_obstruction_configSky obstruction config string (azimuth_start:azimuth_end:elevation pairs)
terrain_based_horizon_coverageUse terrain-based horizon coverage from elevation model
installation_heightInstallation height above ground in meters
shading_configNear-field shading config string (matrix format)
second_array_slopeSecond array tilt angle in degrees
second_array_orientationSecond array azimuth in degrees
second_array_ground_coverage_ratioSecond array ground coverage ratio
second_array_shading_configSecond array shading config string
second_array_power_kwSecond array peak power in kW
pv_technology_typePV cell technology type
diffuse_radiation_modelDiffuse radiation transposition model
inverter_clip_max_threshold_percentInverter clipping max threshold in % of nominal power
inverter_clip_min_threshold_percentInverter clipping min threshold in % of nominal power
snow_slide_coefficientSnow slide coefficient (0=no sliding, 1=very fast slide-off)
Headers
AuthorizationBearer token. Format: Bearer YOUR_API_KEY
System › Responses
Successful Response
History
query Parameters
start_dateStart date for historical data (YYYY-MM-DD)
end_dateEnd date for historical data (YYYY-MM-DD)
latitudeLatitude in decimal degrees
longitudeLongitude in decimal degrees
slopeModule tilt angle in degrees (0=horizontal, 90=vertical)
orientationModule azimuth in degrees (0=North, 90=East, 180=South, 270=West)
pv_power_kwPV system peak power in kW
yearly_energy_consumptionYearly household energy consumption in MWh
yearly_heat_pump_consumptionYearly heat pump energy consumption in MWh
yearly_base_consumptionYearly base load consumption in MWh
battery_capacityBattery storage capacity in kWh
elevationElevation in meters above sea level. -999 = auto-detect from terrain model
air_cool_configAir cooling monthly config: string of 12 digits (0 or 1), one per month
air_cool_temperature_thresholdAir cooling activation temperature in °C
air_cool_peak_powerAir cooling peak power in kW
charge_power_ratioBattery charge power ratio (C-rate)
discharge_power_ratioBattery discharge power ratio (C-rate)
battery_efficiencyRound-trip battery efficiency
demand_profileLoad demand profile type
temperature_coefficient_powerTemperature coefficient of power in %/°C
mounting_typeMounting type: 'open' (free-standing), 'mix' (partially ventilated), 'isol' (building-integrated)
panel_age_yearsAge of the PV panels in years
ground_albedoGround reflectance (albedo)
cable_loss_rateDC cable loss rate as fraction (e.g. 0.015 = 1.5%)
conversion_loss_rateInverter/conversion loss rate as fraction
ground_coverage_ratioGround coverage ratio for row self-shading (0=no rows, 1=fully covered)
tracker_system_typeTracker type: 0=fixed, 1=single-axis, 2=dual-axis
single_axis_tracker_configSingle-axis tracker config string (axis_azimuth:axis_tilt:max_angle:backtracking)
sky_obstruction_configSky obstruction config string (azimuth_start:azimuth_end:elevation pairs)
terrain_based_horizon_coverageUse terrain-based horizon coverage from elevation model
installation_heightInstallation height above ground in meters
shading_configNear-field shading config string (matrix format)
second_array_slopeSecond array tilt angle in degrees
second_array_orientationSecond array azimuth in degrees
second_array_ground_coverage_ratioSecond array ground coverage ratio
second_array_shading_configSecond array shading config string
second_array_power_kwSecond array peak power in kW
pv_technology_typePV cell technology type
diffuse_radiation_modelDiffuse radiation transposition model
use_only_satellite_dataUse only satellite-derived irradiance data
inverter_clip_max_threshold_percentInverter clipping max threshold in % of nominal power
inverter_clip_min_threshold_percentInverter clipping min threshold in % of nominal power
snow_slide_coefficientSnow slide coefficient (0=no sliding, 1=very fast slide-off)
required_dataComma-separated list of output data columns
timezoneOutput timezone (e.g. 'utc', 'Europe/Berlin')
pv_onlyReturn only PV data without battery/consumption simulation
Headers
AuthorizationBearer token. Format: Bearer YOUR_API_KEY
History › Responses
Successful Response
Forecast
query Parameters
latitudeLatitude in decimal degrees
longitudeLongitude in decimal degrees
slopeModule tilt angle in degrees (0=horizontal, 90=vertical)
orientationModule azimuth in degrees (0=North, 90=East, 180=South, 270=West)
forecast_daysNumber of forecast days
past_daysNumber of past days to include
pv_power_kwPV system peak power in kW
yearly_energy_consumptionYearly household energy consumption in MWh
yearly_heat_pump_consumptionYearly heat pump energy consumption in MWh
yearly_base_consumptionYearly base load consumption in MWh
battery_capacityBattery storage capacity in kWh
elevationElevation in meters above sea level. -999 = auto-detect from terrain model
air_cool_configAir cooling monthly config: string of 12 digits (0 or 1), one per month
air_cool_temperature_thresholdAir cooling activation temperature in °C
air_cool_peak_powerAir cooling peak power in kW
charge_power_ratioBattery charge power ratio (C-rate)
discharge_power_ratioBattery discharge power ratio (C-rate)
battery_efficiencyRound-trip battery efficiency
demand_profileLoad demand profile type
temperature_coefficient_powerTemperature coefficient of power in %/°C
mounting_typeMounting type: 'open' (free-standing), 'mix' (partially ventilated), 'isol' (building-integrated)
panel_age_yearsAge of the PV panels in years
ground_albedoGround reflectance (albedo)
cable_loss_rateDC cable loss rate as fraction (e.g. 0.015 = 1.5%)
conversion_loss_rateInverter/conversion loss rate as fraction
ground_coverage_ratioGround coverage ratio for row self-shading (0=no rows, 1=fully covered)
tracker_system_typeTracker type: 0=fixed, 1=single-axis, 2=dual-axis
single_axis_tracker_configSingle-axis tracker config string (axis_azimuth:axis_tilt:max_angle:backtracking)
sky_obstruction_configSky obstruction config string (azimuth_start:azimuth_end:elevation pairs)
terrain_based_horizon_coverageUse terrain-based horizon coverage from elevation model
installation_heightInstallation height above ground in meters
shading_configNear-field shading config string (matrix format)
second_array_slopeSecond array tilt angle in degrees
second_array_orientationSecond array azimuth in degrees
second_array_ground_coverage_ratioSecond array ground coverage ratio
second_array_shading_configSecond array shading config string
second_array_power_kwSecond array peak power in kW
pv_technology_typePV cell technology type
diffuse_radiation_modelDiffuse radiation transposition model
inverter_clip_max_threshold_percentInverter clipping max threshold in % of nominal power
inverter_clip_min_threshold_percentInverter clipping min threshold in % of nominal power
snow_slide_coefficientSnow slide coefficient (0=no sliding, 1=very fast slide-off)
required_dataComma-separated list of output data columns
timezoneOutput timezone (e.g. 'utc', 'Europe/Berlin')
pv_onlyReturn only PV data without battery/consumption simulation
clearsky_dataInclude clear-sky reference data
nowcastImproved Forecast with nowcast
variability_48hEstimate Variablility in Forecast for next 2 days
Headers
AuthorizationBearer token. Format: Bearer YOUR_API_KEY
Forecast › Responses
Successful Response
Recent
query Parameters
latitudeLatitude in decimal degrees
longitudeLongitude in decimal degrees
slopeModule tilt angle in degrees (0=horizontal, 90=vertical)
orientationModule azimuth in degrees (0=North, 90=East, 180=South, 270=West)
start_dateStart date for historical data (YYYY-MM-DD)
end_dateEnd date for historical data (YYYY-MM-DD)
pv_power_kwPV system peak power in kW
yearly_energy_consumptionYearly household energy consumption in MWh
yearly_heat_pump_consumptionYearly heat pump energy consumption in MWh
yearly_base_consumptionYearly base load consumption in MWh
battery_capacityBattery storage capacity in kWh
elevationElevation in meters above sea level. -999 = auto-detect from terrain model
air_cool_configAir cooling monthly config: string of 12 digits (0 or 1), one per month
air_cool_temperature_thresholdAir cooling activation temperature in °C
air_cool_peak_powerAir cooling peak power in kW
charge_power_ratioBattery charge power ratio (C-rate)
discharge_power_ratioBattery discharge power ratio (C-rate)
battery_efficiencyRound-trip battery efficiency
demand_profileLoad demand profile type
temperature_coefficient_powerTemperature coefficient of power in %/°C
mounting_typeMounting type: 'open' (free-standing), 'mix' (partially ventilated), 'isol' (building-integrated)
panel_age_yearsAge of the PV panels in years
ground_albedoGround reflectance (albedo)
cable_loss_rateDC cable loss rate as fraction (e.g. 0.015 = 1.5%)
conversion_loss_rateInverter/conversion loss rate as fraction
ground_coverage_ratioGround coverage ratio for row self-shading (0=no rows, 1=fully covered)
tracker_system_typeTracker type: 0=fixed, 1=single-axis, 2=dual-axis
single_axis_tracker_configSingle-axis tracker config string (axis_azimuth:axis_tilt:max_angle:backtracking)
sky_obstruction_configSky obstruction config string (azimuth_start:azimuth_end:elevation pairs)
terrain_based_horizon_coverageUse terrain-based horizon coverage from elevation model
installation_heightInstallation height above ground in meters
shading_configNear-field shading config string (matrix format)
second_array_slopeSecond array tilt angle in degrees
second_array_orientationSecond array azimuth in degrees
second_array_ground_coverage_ratioSecond array ground coverage ratio
second_array_shading_configSecond array shading config string
second_array_power_kwSecond array peak power in kW
pv_technology_typePV cell technology type
diffuse_radiation_modelDiffuse radiation transposition model
pv_onlyReturn only PV data without battery/consumption simulation
inverter_clip_max_threshold_percentInverter clipping max threshold in % of nominal power
inverter_clip_min_threshold_percentInverter clipping min threshold in % of nominal power
snow_slide_coefficientSnow slide coefficient (0=no sliding, 1=instant slide-off)
required_dataComma-separated list of output data columns
timezoneOutput timezone (e.g. 'utc', 'Europe/Berlin')
Headers
AuthorizationBearer token. Format: Bearer YOUR_API_KEY
Recent › Responses
Successful Response