Schemas
ErrorResponse
error
object · required
Error
message
string · required
Latitude
Longitude
AltitudeOption
^(auto|-?[0-9]+(\.[0…
Altitude in meters above sea level. • auto: Automatic • number: altitude in meters
Altitude
Altitude in meters above sea level.
SurfaceAzimuth
Orientation of the solar panel. North Azimuth.
Conventions:
• 0° = oriented towards the north
• 90° = oriented towards the east
• 180° = oriented towards the south
• 270° = oriented towards the west
SurfaceTilt
Tilt angle of the solar panel.
• 0° = horizontal
• 90° = vertical
TimeZone
UTC offset in hours.
Horizon
^(auto|flat|[0-9]+(,…
Horizon of the requested location.
• flat: Flat horizon (all values are 0°).
• auto: Horizon is determined automatically using a global 30m digital elevation model.
• [comma-separated values]
[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°. Index corresponds 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
HorizonElevation
Situation
Local terrain situation.
Albedo
Local albedo
Turbidity
^(auto|[0-9]*\.?[0-9…
Monthly atmospheric turbidity.
• auto: turbidity is taken from the Meteonorm database.
• [comma-separated values]: 12 floating point values representing monthly atmospheric turbidity.
DataVersion
FutureScenario
FutureYear
ClimateFrequency
Frequency
RadiationMinuteModel
DiffuseRadiationModel
TiltRadiationModel
ClearSkyModel
RandomSeed
ExtremeSetting
ResponseFormat
ClimateParameters
ForecastParameters
ObservationParameters
ClimateResponse
start_times
string[] · requiredStart or end date/time of each time series interval.
end_times
string[] · requiredStart or end date/time of each time series interval.
values
object · requiredTime series values.
quality_parameters
object · requiredmeta
object · required
ForecastResponse
start_times
string[] · requiredStart or end date/time of each time series interval.
end_times
string[] · requiredStart or end date/time of each time series interval.
values
object · requiredTime series values.
meta
object · required
ObservationResponse
start_times
string[] · requiredStart or end date/time of each time series interval.
end_times
string[] · requiredStart or end date/time of each time series interval.
values
object · requiredTime series values.
meta
object · required
TimePoints
TimePoint
Metadata
frequency
string · enum · requiredEnum values:1_hour15_minutes1_minuteparameters
object[] · requiredlat
number · double · min: -90 · max: 90 · requiredExample: 47.3768lon
number · double · min: -180 · max: 180 · requiredExample: 8.5417altitude
number · double · min: -1000 · max: 10000 · requiredAltitude in meters above sea level.
surface_azimuth
number · double · max: 360 · requiredOrientation of the solar panel. North Azimuth.
Conventions:
• 0° = oriented towards the north
• 90° = oriented towards the east
• 180° = oriented towards the south
• 270° = oriented towards the westExample: 1860surface_tilt
number · double · max: 90 · requiredTilt angle of the solar panel.
• 0° = horizontal
• 90° = vertical
time_zone
number · enum · doubleUTC offset in hours.
Enum values:-12-11-10-9.5-9-8-7-6
Parameter
description
string · requiredDescription of parameter
Example: Global horizontal irradiancename
string · requiredunique name of parameter
Example: global_horizontal_irradianceunit
object · requiredaggregation_method
string · enum · requiredEnum values:averageinstantminmaxsumExample: average
Values
Unit
name
string · requiredstring representation of unit
Example: W/m**2description
string · requireddescription of unit
Example: Watt per square meter
AltitudeResponse
altitude
number · double · min: -1000 · max: 10000 · requiredAltitude in meters above sea level.
HorizonResponse
azimuth
integer[] · minItems: 360 · maxItems: 360 · requiredAzimuth angles (in degrees) corresponding to horizon elevation angles in "HorizonElevation".
0° = north, 90° = east, 180° = south, 270° = west.elevation
integer[] · minItems: 360 · maxItems: 360 · required360 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.
Example: [20,20,20,19,18,17,...,0,0,0,0,0,0,...,18,19,20,20,20,20]