Schemas
AccountResponse
Product
nameName of the product.
valid_untilEnd date of the product validity period.
balanceCurrent tokens/AMY calculations remaining.
refill_dateDate when the monthly quota is refilled. Null for non-subscription products.
ErrorResponse
AltitudeOption
^(auto|-?[0-9]+(\.[0…Altitude in meters above sea level.
• auto: Automatic • number: altitude in meters
SurfaceAzimuth
• 0° = oriented towards the north
• 90° = oriented towards the east
• 180° = oriented towards the south
• 270° = oriented towards the west
TrackingMode
• none: No axis tracking. Fixed surface orientation (uses surface_azimuth and surface_tilt parameters).
• 1_axis: Single-axis tracking.
In this mode, parameters surface_azimuth and surface_tilt are ignored.
The solar panels are mounted on a rotational axis parallel to the ground along a North-South line,
tilting dynamically East-to-West to follow the sun's trajectory throughout the day.
Backtracking is applied: the tracking angle does not follow the sun in a naïve way.
Instead, for low sun angles, it moves backwards to its ideal position to prevent row-to-row shading in PV arrays.
The maximum tilt angle is 45° and a ground coverage ratio (GCR) of 0.3 is assumed.
Horizon
^(auto|flat|[0-9]+(,…• flat: Flat horizon (all values are 0°).
• auto: Horizon is determined automatically using a global 30m digital elevation model.
• [comma-separated values]: provide 360 integer values representing elevation angles
(in degrees) of the horizon in 360 directions.
Elevation angles must be ≥0° and <90°.
List indices 0–359 correspond to azimuth:
Index 0 = 0° (North)
Index 90 = 90° (East)
Index 180 = 180° (South)
Index 270 = 270° (West)
Each value indicates the elevation angle at the corresponding azimuth.
HorizonAzimuth
Azimuth angles (in degrees) corresponding to horizon elevation angles in "HorizonElevation".
0° = north, 90° = east, 180° = south, 270° = west.
HorizonElevation
360 integer values representing elevation angles (0° to 90°) of the horizon. Array indices correspond to azimuths, e.g. index 0 corresponds to azimuth 0°. Each value indicates the elevation angle at the corresponding azimuth. The given example corresponds to a "20° mountain" in the north and a flat horizon in all other directions.
Situation
• open: Open site, open terrain, north facing incline, no raised skyline. Applies to most sites.
• depression: Depression or very flat valley floor, in which cold air collects. In Switzerland, for example, particularly in
the Jura and the Alps.
• cold_air_lake: Extensively cold hollows (above 1000 m).
• sea_lake: Shore of sea or larger lake (up to 1 km from the shore).
• city: Centre of a larger city (over 100’000 inhabitants).
• slope_south: South facing incline (more than approx. 10° inclination, facing between SE–S–SW). At least 200 m above valley floor.
• slope_west_east: West or east facing incline (more than approx. 10° inclination, facing between SW–W–NW or NE–E–SE). At least 200 m above valley floor.
• valley: Valley floor in mountainous valley at higher altitudes. Valley floor inclined (flat valleys are often treated as depressions).
• valley_foehn: Valley floor of Föhn valley (regions with warm descending air currents).
• valley_central_alps: Floor of large central Alpine valley (e.g. Alpine regions of Valais, Switzerland).
• valley_alpine_foothills: Valley floor in northern Alpine foothills.
• valley_slope_south: South facing incline (more than approx. 10° inclination, facing between SE–S–SW) up to 200 m above valley.
• valley_slope_west_east: West or east facing incline (more than approx. 10° inclination, facing between SW–W–NW or NE–E–SE) up to 200 m above valley floor.
• summit: Open summit above 500 m. Overlooking surroundings in all directions.
Turbidity
^(auto|[0-9]*\.?[0-9…• auto: turbidity is taken from the Meteonorm database.
• [comma-separated values]: 12 floating point values representing monthly atmospheric turbidity.
MonthlyImportData
global_horizontal_irradianceMonthly mean global horizontal irradiance, in W/m². 12 values, one per month, describing a full 12-month period.
temperatureMonthly mean air temperature, in °C. 12 values, one per month, describing a full 12-month period.
ClimateImportMode
Selects how the imported monthly values are interpreted.
• typical: The user-provided monthly values describe a typical meteorological year (TMY). They are interpreted as January to December and the output covers a January-to-December year. The start field is ignored.
• actual: The user-provided monthly values describe an actual meteorological year (AMY). The start field is required (the request fails without it) and the 12 values are interpreted as the 12 months beginning at that month.
ClimateImportStartTime
^[0-9]{4}-[0-9]{2}$Start month of the imported values.
A year-month string in the format YYYY-MM.
Required when the mode is "actual". Ignored when the mode is "typical", where the values always cover a January-to-December year.
Examples:
2020-01
2023-12
ClimateImportMonthlyRequest
latlonmodeSelects how the imported monthly values are interpreted.
• typical: The user-provided monthly values describe a typical meteorological year (TMY). They are interpreted as January to December and the output covers a January-to-December year. The start field is ignored.
• actual: The user-provided monthly values describe an actual meteorological year (AMY). The start field is required (the request fails without it) and the 12 values are interpreted as the 12 months beginning at that month.
User-supplied monthly mean values. Global horizontal irradiance is required; temperature is optional and falls back to the Meteonorm database when omitted.
altitude^(auto|-?[0-9]+(\.[0…Altitude in meters above sea level.
• auto: Automatic • number: altitude in meters
surface_azimuth• 0° = oriented towards the north
• 90° = oriented towards the east
• 180° = oriented towards the south
• 270° = oriented towards the west
surface_tilt• 0° = horizontal
• 90° = vertical
tracking_mode• none: No axis tracking. Fixed surface orientation (uses surface_azimuth and surface_tilt parameters).
• 1_axis: Single-axis tracking.
In this mode, parameters surface_azimuth and surface_tilt are ignored.
The solar panels are mounted on a rotational axis parallel to the ground along a North-South line,
tilting dynamically East-to-West to follow the sun's trajectory throughout the day.
Backtracking is applied: the tracking angle does not follow the sun in a naïve way.
Instead, for low sun angles, it moves backwards to its ideal position to prevent row-to-row shading in PV arrays.
The maximum tilt angle is 45° and a ground coverage ratio (GCR) of 0.3 is assumed.
situation• open: Open site, open terrain, north facing incline, no raised skyline. Applies to most sites.
• depression: Depression or very flat valley floor, in which cold air collects. In Switzerland, for example, particularly in
the Jura and the Alps.
• cold_air_lake: Extensively cold hollows (above 1000 m).
• sea_lake: Shore of sea or larger lake (up to 1 km from the shore).
• city: Centre of a larger city (over 100’000 inhabitants).
• slope_south: South facing incline (more than approx. 10° inclination, facing between SE–S–SW). At least 200 m above valley floor.
• slope_west_east: West or east facing incline (more than approx. 10° inclination, facing between SW–W–NW or NE–E–SE). At least 200 m above valley floor.
• valley: Valley floor in mountainous valley at higher altitudes. Valley floor inclined (flat valleys are often treated as depressions).
• valley_foehn: Valley floor of Föhn valley (regions with warm descending air currents).
• valley_central_alps: Floor of large central Alpine valley (e.g. Alpine regions of Valais, Switzerland).
• valley_alpine_foothills: Valley floor in northern Alpine foothills.
• valley_slope_south: South facing incline (more than approx. 10° inclination, facing between SE–S–SW) up to 200 m above valley.
• valley_slope_west_east: West or east facing incline (more than approx. 10° inclination, facing between SW–W–NW or NE–E–SE) up to 200 m above valley floor.
• summit: Open summit above 500 m. Overlooking surroundings in all directions.
horizon^(auto|flat|[0-9]+(,…• flat: Flat horizon (all values are 0°).
• auto: Horizon is determined automatically using a global 30m digital elevation model.
• [comma-separated values]: provide 360 integer values representing elevation angles
(in degrees) of the horizon in 360 directions.
Elevation angles must be ≥0° and <90°.
List indices 0–359 correspond to azimuth:
Index 0 = 0° (North)
Index 90 = 90° (East)
Index 180 = 180° (South)
Index 270 = 270° (West)
Each value indicates the elevation angle at the corresponding azimuth.
parametersfixed_albedoLocal albedo
turbidity^(auto|[0-9]*\.?[0-9…• auto: turbidity is taken from the Meteonorm database.
• [comma-separated values]: 12 floating point values representing monthly atmospheric turbidity.
frequencyresponse_formatradiation_minute_modeldiffuse_radiation_modeltilt_radiation_modelrandom_seedclear_sky_radiation_modelstart^[0-9]{4}-[0-9]{2}$Start month of the imported values.
A year-month string in the format YYYY-MM.
Required when the mode is "actual". Ignored when the mode is "typical", where the values always cover a January-to-December year.
Examples:
2020-01
2023-12
FutureScenario
• none: climate reference period is 2001–2020.
• ssp1_26: Shared Socioeconomic Pathway (as defined by the IPCC) SSP1-2.6.
• ssp2_45: Shared Socioeconomic Pathway (as defined by the IPCC) SSP2-4.5.
• ssp3_70: Shared Socioeconomic Pathway (as defined by the IPCC) SSP3-7.0.
ExtremeSetting
ClimateParameters
ForecastParameters
ObservationParameters
ValuesClimate
global_horizontal_irradianceglobal_horizontal_irradiance_with_shadingdirect_horizontal_irradiancedirect_horizontal_irradiance_with_shadingdiffuse_horizontal_irradiancediffuse_horizontal_irradiance_with_shadingdirect_normal_irradiancedirect_normal_irradiance_with_shadingglobal_tilted_irradianceglobal_tilted_irradiance_with_shadingdirect_tilted_irradiancedirect_tilted_irradiance_with_shadingdiffuse_tilted_irradiancediffuse_tilted_irradiance_with_shadingpv_productionpv_production_with_shadingglobal_clear_sky_irradiancedirect_horizontal_clear_sky_irradiancediffuse_clear_sky_irradiancedirect_normal_clear_sky_irradianceprecipitationtemperaturedew_point_temperaturesnow_depthglobal_extraterrestrial_irradianceglobal_extraterrestrial_normal_irradiancedownwelling_longwave_irradianceupwelling_longwave_irradiancevertical_longwave_irradiancephoto_active_irradianceradiation_balanceglobal_illuminancedirect_illuminancediffuse_illuminancelinke_turbidity_factoraerosol_optical_depthcloud_coveralbedosurface_temperaturesky_temperaturewet_bulb_temperaturemixing_ratiorelative_humidityprecipitable_waterdriving_rainpressurewind_speedwind_directionsolar_elevationsolar_azimuthsurface_azimuthsurface_tiltClimateTMYQualityParameters
start_year_of_irradiance_period_of_nearest_stationStart year of the irradiance data period at the nearest station.
end_year_of_irradiance_period_of_nearest_stationEnd year of the irradiance data period at the nearest station.
irradiance_station_data_weightWeight of the station data in the global irradiance estimation.
uncertainty_of_irradiance_estimationUncertainty of the global irradiance estimation.
uncertainty_of_temperature_estimationUncertainty of the temperature estimation.
irradiance_year_to_year_variabilityYear-to-year variability of the global irradiance.
irradiance_yearly_poe10The yearly irradiance level associated with a 10% probability of exceedance (PoE10). This value corresponds to the 90th percentile of the irradiance distribution.
irradiance_yearly_poe90The yearly irradiance level associated with a 90% probability of exceedance (PoE90). This value corresponds to the 90th percentile of the irradiance distribution.
ClimateTMYResponse
start_timesStart or end ISO 8601 date-time strings of each time series interval.
end_timesStart or end ISO 8601 date-time strings of each time series interval.
Time series of a climate response.
Quality parameters for the TMY climate data.
ClimateAMYResponse
start_timesStart or end ISO 8601 date-time strings of each time series interval.
end_timesStart or end ISO 8601 date-time strings of each time series interval.
Time series of a climate response.
ClimateImportResponse
start_timesStart or end ISO 8601 date-time strings of each time series interval.
end_timesStart or end ISO 8601 date-time strings of each time series interval.
Time series of a climate response.
ValuesForecast
global_horizontal_irradianceglobal_horizontal_irradiance_with_shadingdirect_horizontal_irradiancedirect_horizontal_irradiance_with_shadingdiffuse_horizontal_irradiancediffuse_horizontal_irradiance_with_shadingdirect_normal_irradiancedirect_normal_irradiance_with_shadingglobal_tilted_irradianceglobal_tilted_irradiance_with_shadingdirect_tilted_irradiancedirect_tilted_irradiance_with_shadingdiffuse_tilted_irradiancediffuse_tilted_irradiance_with_shadingpv_productionpv_production_with_shadingglobal_clear_sky_irradianceprecipitationtemperaturedew_point_temperaturesnow_depthcloud_coverrelative_humiditypressurewind_speedwind_directionwind_gustsweather_symbolsurface_azimuthsurface_tiltForecastResponse
start_timesStart or end ISO 8601 date-time strings of each time series interval.
end_timesStart or end ISO 8601 date-time strings of each time series interval.
Time series of a forecast response.
ValuesObservation
global_horizontal_irradianceglobal_horizontal_irradiance_with_shadingdirect_horizontal_irradiancedirect_horizontal_irradiance_with_shadingdiffuse_horizontal_irradiancediffuse_horizontal_irradiance_with_shadingdirect_normal_irradiancedirect_normal_irradiance_with_shadingglobal_tilted_irradianceglobal_tilted_irradiance_with_shadingdirect_tilted_irradiancedirect_tilted_irradiance_with_shadingdiffuse_tilted_irradiancediffuse_tilted_irradiance_with_shadingpv_productionpv_production_with_shadingglobal_clear_sky_irradiancetemperaturesnow_depthsurface_azimuthsurface_tiltObservationResponse
start_timesStart or end ISO 8601 date-time strings of each time series interval.
end_timesStart or end ISO 8601 date-time strings of each time series interval.
Time series of an observation response.
Metadata
versionMeteonorm version used to generate the response
commitCommit hash of the Meteonorm backend used to generate the response
frequencylatlonaltitudeAltitude in meters above sea level.
surface_azimuth• 0° = oriented towards the north
• 90° = oriented towards the east
• 180° = oriented towards the south
• 270° = oriented towards the west
surface_tilt• 0° = horizontal
• 90° = vertical
time_zoneUTC offset in hours.
Parameter
descriptionDescription of parameter
nameunique name of parameter
aggregation_methodUnit
namestring representation of unit
descriptiondescription of unit
AltitudeResponse
altitudeAltitude in meters above sea level.
HorizonResponse
azimuthAzimuth angles (in degrees) corresponding to horizon elevation angles in "HorizonElevation".
0° = north, 90° = east, 180° = south, 270° = west.
elevation360 integer values representing elevation angles (0° to 90°) of the horizon. Array indices correspond to azimuths, e.g. index 0 corresponds to azimuth 0°. Each value indicates the elevation angle at the corresponding azimuth. The given example corresponds to a "20° mountain" in the north and a flat horizon in all other directions.