Output parameter definitions

Use the output_parameters query parameter to select which fields are returned in the response. Each endpoint supports a subset of the parameters listed below. Pass a comma-separated list of keys — for example,output_parameters=air_temp,ghi,cloud_opacity.

Irradiance and Weather

Key	Unit	Description
`air_temp`	°C	The air temperature at 2 metres above surface level.
`albedo`	fraction	The average daytime surface reflectivity of visible light, expressed as a fractional value between 0 and 1. 0 represents complete absorption. 1 represents complete reflection. This is an interpolated daily average value, therefore does not capture any diurnal angular dependence of reflectivity.
`azimuth`	°	The angle between the horizontal direction of the sun, and due north, with negative angles eastwards and positive values westward . Varies from -180 to 180. A value of -90 means the sun is in the east, 0 means north, and 90 means west.
`cape`	J/kg	Convective Available Potential Energy (CAPE) is the energy available for a thunderstorm. CAPE provides an estimate of the energy that a thunderstorm updraught will release as it rises and the water vapour it contains condenses to liquid water, releasing latent heat. It is a measure of deep atmospheric instability which is one of the necessary conditions for a thunderstorm. While large values of CAPE (many 100s to 1000s of J/kg) indicate a favourable environment for a thunderstorm to occur, to get a thunderstorm it is also necessary to have a triggering mechanism to initiate it, and other suitable environmental wind and moisture conditions to support its growth. Large values of CAPE, when combined with precipitation_rate output being > 0 can be used as a simple proxy for a thunderstorm event.
`clearsky_dhi`	W/m2	The diffuse irradiance received on a horizontal surface (if there are no clouds). Also referred to as Diffuse Sky Radiation. The diffuse component is irradiance that is scattered by the atmosphere, in the clear sky scenario, (i.e. no water or ice clouds in the sky).
`clearsky_dni`	W/m2	Irradiance received from the direct beam of the sun (if there are no clouds).. Also referred to as beam radiation.
`clearsky_ghi`	W/m2	Total irradiance on a horizontal surface (if there are no clouds). The sum of direct and diffuse irradiance components received on a horizontal surface, in the clear sky scenario, (i.e. no water or ice clouds in the sky).
`clearsky_gti`	W/m2	Total irradiance received on a surface, with defined tilt and azimuth for fixed or tracking systems as the sum of direct, diffuse and reflected irradiance components as if there were no clouds. If you specify an array_type of "fixed", you can optionally specify a tilt and azimuth, or else we assume default values (equatorward-facing azimuth, latitude-dependent tilt). If you specify an array_type of "horizontal_single_axis", you can specify the tracker axis angle as azimuth, or else we assume a default value of zero (i.e. tracker axis runs north-south). Tilt is ignored if provided for an array_type of "horizontal_single_axis".
`cloud_opacity`	%	The attenuation of incoming sunlight due to cloud. Varies from 0% (no cloud) to 100% (full attenuation of incoming sunlight).
`cloud_opacity10`	%	The attenuation of incoming sunlight due to cloud (10th percentile clearness). Varies from 0% (no cloud) to 100% (full attenuation of incoming sunlight). In the 10th percentile scenario of clearness.
`cloud_opacity90`	%	The attenuation of incoming sunlight due to cloud (90th percentile clearness). Varies from 0% (no cloud) to 100% (full attenuation of incoming sunlight). In the 90th percentile scenario of clearness.
`dewpoint_temp`	°C	The dewpoint temperature at 2 metres above surface level.
`dhi`	W/m2	The diffuse irradiance received on a horizontal surface. Also referred to as Diffuse Sky Radiation. The diffuse component is irradiance that is scattered by the atmosphere.
`dhi10`	W/m2	The diffuse irradiance received on a horizontal surface (10th percentile clearness).
`dhi90`	W/m2	The diffuse irradiance received on a horizontal surface (90th percentile clearness).
`dni`	W/m2	Irradiance received from the direction of the sun (10th percentile clearness). Also referred to as beam radiation.
`dni10`	W/m2	Irradiance received from the direction of the sun (10th percentile clearness). Also referred to as beam radiation. In the 10th percentile scenario of clearness (i.e. cloudier than expected).
`dni90`	W/m2	Irradiance received from the direction of the sun (10th percentile clearness). Also referred to as beam radiation. In the 90th percentile scenario of clearness (i.e. less cloudy than expected).
`ghi`	W/m2	Total irradiance on a horizontal surface. The sum of direct and diffuse irradiance components received on a horizontal surface.
`ghi10`	W/m2	Total irradiance on a horizontal surface (10th percentile clearness). The sum of direct and diffuse irradiance components received on a horizontal surface, in the 10th percentile scenario of clearness (i.e. cloudier than expected).
`ghi90`	W/m2	Total irradiance on a horizontal surface (90th percentile clearness). The sum of direct and diffuse irradiance components received on a horizontal surface, in the 90th percentile scenario of clearness (i.e. less cloudy than expected).
`gti`	W/m2	Total irradiance received on a surface with defined tilt and azimuth for fixed or tracking systems as the sum of direct, diffuse and reflected irradiance components. If you specify an array_type of "fixed", you can optionally specify a tilt and azimuth, or else we assume default values (equatorward-facing azimuth, latitude-dependent tilt). If you specify an array_type of "horizontal_single_axis", you can specify the tracker axis angle as azimuth, or else we assume a default value of zero (i.e. tracker axis runs north-south). Tilt is ignored if provided for an array_type of "horizontal_single_axis".
`gti10`	W/m2	Total irradiance received on a surface with defined tilt and azimuth (sum of direct, diffuse and reflected components), fixed or tracking (10th percentile clearness).
`gti90`	W/m2	Total irradiance received on a surface with defined tilt and azimuth (sum of direct, diffuse and reflected components), fixed or tracking (90th percentile clearness).
`max_air_temp`	°C	The daily maximum air temperature at 2 metres above surface level.
`min_air_temp`	°C	The daily minimum air temperature at 2 metres above surface level.
`pm10`	µg/m³	The concentration of particulate matter with a diameter of less than 10 micrometers in the air.
`pm2.5`	µg/m³	The concentration of particulate matter with a diameter of less than 2.5 micrometers in the air.
`precipitable_water`	kg/m2	Precipitable water of the entire atmospheric column.
`precipitation_rate`	mm/h	Precipitation rate. An estimate of the average precipitation rate during the selected period - not an accumulated value.
`relative_humidity`	%	The relative humidity at 2 metres above ground level. Relative humidity is the amount of water vapour as a percentage of the amount needed for saturation at the same temperature. A value of 50% means the air is 50% saturated.
`snow_depth`	cm	Snow pack depth. A measure of the physical snow pack on the ground.
`snow_soiling_ground`	%	Loss in ground mounted PV module (DC) production loss due to snow soiling. 0% means no snow soiling losses. 100% means snow is fully covering all modules. Soiling values are estimated using Solcast snowfall, irradiance and temperature data, following the method of Ryberg and Freeman (NREL, 2017), with Solcast proprietary extensions. Snow clears faster in the Utility parameter, compared to the Rooftop parameter.
`snow_soiling_rooftop`	%	Loss in rooftop PV module (DC) production loss due to snow soiling. 0% means no snow soiling losses. 100% means snow is fully covering all modules. Soiling values are estimated using Solcast snowfall, irradiance and temperature data, following the method of Ryberg and Freeman (NREL, 2017), with Solcast proprietary extensions.
`snow_water_equivalent`	cm	The snow depth liquid-water-equivalent.. The snow depth liquid-water-equivalent.
`snowfall_rate`	cm/h	The depth of snow falling per unit time. The snowfall rate is based on the water-equivalent amount of frozen precipitation falling per hour, converted to a solid snow depth using an estimate of the density of newly fallen snow. The snowfall rate will generally not match the change in the snow_depth output parameter over an hour. This is because snow_depth is also affected by other processes, such as melting, evaporation and changes in density of the total snow pack.
`surface_pressure`	hPa	The air pressure at surface level.
weather_type	string	A simple categorisation of the weather conditions. See weather type values below for the full list.
`wind_direction_100m`	°	Wind direction at 100m above ground level. Zero means true north. Varies from 0 to 360. A value of 270 means the wind is coming from the west
`wind_direction_10m`	°	Wind direction at 10m above ground level. Zero means true north. Varies from 0 to 360. A value of 270 means the wind is coming from the west
`wind_gust`	m/s	The maximum wind gust speed at 10m above ground level. The wind gust is based on the maximum 10m wind speed when averaged over 3 seconds. The wind gust can give a better indication of the damage potential of wind than the wind_speed_10m output parameter does.
`wind_speed_100m`	m/s	Wind speed at 100m above ground level.
`wind_speed_10m`	m/s	Wind speed at 10m above ground level.
`zenith`	°	The angle between the direction of the sun, and the zenith (directly overhead). The zenith angle is 90 degrees at sunrise and sunset, and 0 degrees when the sun is directly overhead.

Grid Aggregation

Key	Unit	Description
`percentage`	%	PV power output (%)
`percentage10`	%	PV power output (%) 10th percentile
`percentage90`	%	PV power output (%) 90th percentile
`pv_estimate`	MW	PV power output (MW)
`pv_estimate10`	MW	PV power output (MW) 10th percentile
`pv_estimate90`	MW	PV power output (MW) 90th percentile

Rooftop PV Power

Key	Unit	Description
`pv_power_rooftop`	kW	PV power output from the Rooftop PV Model. Output is in terms of inverter (AC) output.
`pv_power_rooftop10`	kW	PV power output from the Rooftop PV Model, based on 10th percentile clearness. Output is in terms of the inverter (AC) output, in the 10th percentile scenario of clearness (i.e. more cloudy than expected).
`pv_power_rooftop90`	kW	PV power output from the Rooftop PV Model, based on 90th percentile clearness. Output is in terms of the inverter (AC) output, in the 90th percentile scenario of clearness (i.e. less cloudy than expected).

Advanced PV Power

Key	Unit	Description
`pv_power_advanced`	MW	PV power output from the Advanced PV Model. Output is in terms of inverter (AC) output.
`pv_power_advanced10`	MW	PV power output from the Advanced PV Model, based on 10th percentile clearness. Output is in terms of the inverter (AC) output, in the 10th percentile scenario of clearness (i.e. more cloudy than expected).
`pv_power_advanced90`	MW	PV power output from the Advanced PV Model, based on 90th percentile clearness. Output is in terms of the inverter (AC) output, in the 90th percentile scenario of clearness (i.e. less cloudy than expected).

Premium PV Power

Key	Unit	Description
`availability`	%	Percentage of generation that is online.
`curtailed_power`	MW	Power output (AC) with availability and curtailments applied.
`curtailed_power_p10`	MW	Power output (AC) with availability and curtailments applied - 10% probability of exceedance.
`curtailed_power_p25`	MW	Power output (AC) with availability and curtailments applied - 25% probability of exceedance.
`curtailed_power_p75`	MW	Power output (AC) with availability and curtailments applied - 75% probability of exceedance.
`curtailed_power_p90`	MW	Power output (AC) with availability and curtailments applied - 90% probability of exceedance.
`curtailment`	MW	Curtailment on generation.
`power`	MW	Power output (AC).
`power_p10`	MW	Power output (AC) - 10% probability of exceedance.
`power_p25`	MW	Power output (AC) - 25% probability of exceedance.
`power_p75`	MW	Power output (AC) - 75% probability of exceedance.
`power_p90`	MW	Power output (AC) - 90% probability of exceedance.

Premium Wind Power

Key	Unit	Description
`availability`	%	Percentage of generation that is online.
`curtailed_power`	MW	Power output (AC) with availability and curtailments applied.
`curtailed_power_p10`	MW	Power output (AC) with availability and curtailments applied - 10% probability of exceedance.
`curtailed_power_p25`	MW	Power output (AC) with availability and curtailments applied - 25% probability of exceedance.
`curtailed_power_p75`	MW	Power output (AC) with availability and curtailments applied - 75% probability of exceedance.
`curtailed_power_p90`	MW	Power output (AC) with availability and curtailments applied - 90% probability of exceedance.
`curtailment`	MW	Curtailment on generation.
`power`	MW	Power output (AC).
`power_p10`	MW	Power output (AC) - 10% probability of exceedance.
`power_p25`	MW	Power output (AC) - 25% probability of exceedance.
`power_p75`	MW	Power output (AC) - 75% probability of exceedance.
`power_p90`	MW	Power output (AC) - 90% probability of exceedance.
`wind_direction_hub_height`	degree	Wind direction at turbine hub height. Zero means true north. Varies from 0 to 360. A value of 270 means the wind is coming from the west
`wind_speed_hub_height`	m/s	Wind speed at turbine hub height.
`wind_speed_hub_height_p10`	m/s	Wind speed at turbine hub height - 10% probability of exceedance.
`wind_speed_hub_height_p25`	m/s	Wind speed at turbine hub height - 25% probability of exceedance.
`wind_speed_hub_height_p75`	m/s	Wind speed at turbine hub height - 75% probability of exceedance.
`wind_speed_hub_height_p90`	m/s	Wind speed at turbine hub height - 90% probability of exceedance.

Weather type values

The weather_type output parameter specifies the general weather condition for the requested location and time. It uses a predefined set of simple categories for common weather scenarios — typically for weather icons. Include it withoutput_parameters=weather_type.

BLOWING SNOW

Falling snow being blown by the wind

CLEAR

Clear sky and sun is set

DAMAGING WIND

Winds strong enough to cause damage

DRIZZLE

Drizzle falling

FOG

Foggy conditions

FROST

Cold, clear and still conditions conducive to formation of frost on exposed surfaces

HAZY

Hazy sky

INTERMITTENT RAIN

Periods of rain and no rain

MIXED PRECIPITATION

Mix of frozen and liquid precipitation

MOSTLY CLEAR

Few clouds and sun is set

MOSTLY CLOUDY

Mostly cloudy sky

MOSTLY SUNNY

Few clouds and sun is up

OVERCAST

Overcast sky

PARTLY CLOUDY

Partly cloudy sky

RAIN

Rain falling

SNOW

Snow falling

SUNNY

Clear sky and sun is up

THUNDERSTORM

Thunderstorm with rain falling

WINDY

Windy conditions

Example response

Select fields with output_parameters

Request

curl "https://api.solcast.com.au/data/forecast/radiation_and_weather?latitude=-33.8567&longitude=151.2152&output_parameters=air_temp,ghi,cloud_opacity&format=json" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "forecasts": [
    {
      "air_temp": 20.1,
      "ghi": 350,
      "cloud_opacity": 42,
      "period_end": "2024-07-17T11:30:00+00:00",
      "period": "PT60M"
    }
  ]
}

Request with weather_type

curl "https://api.solcast.com.au/data/forecast/radiation_and_weather?latitude=-33.8567&longitude=151.2152&output_parameters=weather_type&format=json" \
  -H "Authorization: Bearer $API_KEY"

Response with weather_type

{
  "forecasts": [
    {
      "air_temp": 20.1,
      "ghi": 350,
      "period_end": "2024-07-17T11:30:00+00:00",
      "period": "PT60M",
      "weather_type": "PARTLY CLOUDY"
    }
  ]
}