latestOpenAPI 3.0.12026-08-184787426.1 KB

591461e66c79

Forecast
Soiling Losses

Get Forecast HSU Losses

Get soiling loss forecasts using the HSU model for the requested location from the present up to 14 days ahead.

get/data/forecast/soiling/hsu

Query parameters

latitudenumber double required

The latitude of the location you request data for. Must be a decimal number between -90 and 90.

longitudenumber double required

The longitude of the location you request data for. Must be a decimal number between -180 and 180.

time_zonestring nullable

Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc.

hoursinteger nullable

Time window of the response in hours from 1 to 336. Default is 24.

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

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

depo_veloc_pm10number double nullable

Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004.

depo_veloc_pm2_5number double nullable

Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009.

pm10number[]

Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM10 values tailored to your request time period.

pm2_5number[]

Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period.

tiltnumber double nullable

The angle (degrees) that the PV system is tilted off the horizontal. A tilt of 0 means the system faces directly upwards, and 90 means the system is vertical and facing the horizon. If you don't specify tilt, we use a default tilt angle based on the latitude you specify in your request. Must be between 0 and 90.

cleaning_thresholdnumber double nullable

Amount of daily rainfall required to clean the panels (mm). Default is 1.0.

initial_soilingnumber double nullable

Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437.

manual_wash_datesstring[]

Optional. Default is none. A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded.

format'json' | 'csv' nullable

Response format. Default is HTML if not supplied.

Response

OK

forecastsobject[] nullable