latestOpenAPI 3.0.12026-08-184787426.1 KB

591461e66c79

Forecast
Premium PV Power

Get Forecast Premium PV

get/data/forecast/premium_pv_power

Query parameters

output_parametersstring[]

The output parameters to include in the response.

issue_timestring date-time nullable

Return the forecast issued at this time (ISO 8601). Must be in the past. When omitted, the latest forecast is returned.

request_idstring nullable

Optional request identifier for tracing and log correlation.

hoursinteger nullable

The number of hours to return in the response.

resource_idstring nullable required

The resource id of the resource.

period'PT5M' | 'PT10M' | 'PT15M' | 'PT20M' | 'PT30M' | 'PT60M' nullable

Length of the averaging period in ISO 8601 duration format. Default is PT30M.

apply_availabilitynumber double nullable

Percentage of the site’s total AC (inverter) capacity that is currently generating or expected to be generating during the forecast request period. E.g. if you specify a 50% availability, your returned power will be half of what it otherwise would be.

apply_constraintnumber double nullable

Constraint on site’s total AC production, applied as a cap in the same way as the metadata parameter Site Export Limit. This will constrain all Solcast power values to be no higher than the apply_constraint value you specify. If you need an unconstrained forecast, you should not use this parameter.

apply_dust_soilingnumber double nullable

A user-override for dust_soiling_average. If you specify this parameter in your API call, we will replace the site's annual or monthly average dust soiling values with the value you specify in your API call.E.g. if you specify a 0.7 dust soiling, your returned power will be reduced by 70%.

apply_snow_soilingnumber double nullable

A user-override for Solcast’s dynamic snow soiling, which is based on global snow cover and weather forecast data, and changes from hour to hour. If you specify this parameter in your API call (e.g. if snow clearing has just been performed), we will replace the Solcast dynamic hour to hour value with the single value you specify. E.g. if you specify a 0.7 snow soiling, your returned power will be reduced by 70%.

apply_tracker_inactiveboolean nullable

Indicating if trackers are inactive. If True, panels are assumed all facing up (i.e. zero rotation). Only has effect if your site has a tracking_type that is not “fixed”.

terrain_shadingboolean

If true, irradiance parameters are modified based on the surrounding terrain from a 90m-horizontal-resolution digital elevation model. The direct component of irradiance is set to zero when the beam from the sun is blocked by the terrain. The diffuse component of irradiance is reduced throughout the day if the sky view at the location is significantly reduced by the surrounding terrain. Global irradiance incorporates both effects.

format'json' | 'csv' nullable

Response format. Default is HTML if not supplied.

Response

OK

forecastsobject[] nullable