WeatherService API Documentation (v2)

This documentation describes the WeatherService API, version v2, which provides weather forecasts.

General Information

The WeatherService API allows you to retrieve weather information, including current conditions, minutely, hourly, and daily forecasts. The API is accessed through HTTP endpoints and returns data in JSON format.

Endpoints

/api/v2/weather/point

This endpoint retrieves weather data for a specific point defined by latitude and longitude.

HTTP Method: GET

Parameters

Parameter	Required	Type	Format	Description
apiKey	Yes	string		API key for authentication
latitude	Yes	number	double	Latitude of the point
longitude	Yes	number	double	Longitude of the point
channel	No	string		Channel for the request
dateTimeFrom	No	string	date-time	Start date and time for the weather data
dateTimeUntil	No	string	date-time	End date and time for the weather data
details	No	string		Allows requesting additional weather information using predefined ENUM values. By default, only current weather information is provided. Possible values: ADDRESS (Reverse geocoding for provided coordinates), MINUTELY_15 (15-minute interval data), HOURLY (60-minute interval data), DAILY (daily data). Multiple values can be requested.

Data Models

Address

Defines an address.

Property	Type	Nullable	Description
country	string	Yes	Country of the address
district	string	Yes	District of the address
zip	string	Yes	ZIP code of the address
city	string	Yes	City of the address
cityAddOn	string	Yes	Additional city information
cityPart	string	Yes	City part of the address
street	string	Yes	Street of the address
houseNo	string	Yes	House number of the address

ProblemDetails

Provides details about an error.

Property	Type	Nullable	Description
type	string	Yes	A URI reference that identifies the problem type
title	string	Yes	A short, human-readable summary of the problem
status	integer	Yes	The HTTP status code for this occurrence of the problem
detail	string	Yes	A human-readable explanation specific to this occurrence of the problem
instance	string	Yes	A URI reference that identifies the specific occurrence of the problem

ServiceError

Describes a service error.

Property	Type	Nullable	Description
type	string	Yes	Type of the error
message	string	Yes	Error message

WeatherForecastCurrently

Contains current weather conditions.

Property	Type	Format	Nullable	Description	Unit
timestamp	string	date-time	No	Timestamp of the weather data
interval	number	float	Yes	Interval
temperature2Meters	number	float	Yes	Temperature at 2 meters	°C
relativeHumidity2Meters	number	float	Yes	Relative humidity at 2 meters	%
apparentTemperature	number	float	Yes	Apparent temperature	°C
isDay	boolean		Yes	Indicates if it is day
precipitation	number	float	Yes	Precipitation amount	mm
rain	number	float	Yes	Rain amount	mm
showers	number	float	Yes	Showers amount	mm
snowfall	number	float	Yes	Snowfall amount	cm
weatherCode	integer	int32	Yes	Weather code
cloudCover	number	float	Yes	Cloud cover percentage	%
pressureMsl	number	float	Yes	Pressure at mean sea level	hPa
surfacePressure	number	float	Yes	Surface pressure	hPa
precipitationProbability	number	float	Yes	Probability of precipitation	%
dewPoint2Meters	number	float	Yes	Dew point temperature at 2 meters	°C
visibility	number	float	Yes	Visibility distance	km
sunshineDuration	number	float	Yes	Sunshine duration in seconds	s
windSpeed10Meters	number	float	Yes	Wind speed at 10 meters	km/h
windDirection10Meters	number	float	Yes	Wind direction at 10 meters	°
windGusts10Meters	number	float	Yes	Wind gusts at 10 meters	km/h

WeatherForecastDaily

Provides daily weather forecast data.

Property	Type	Format	Nullable	Description	Unit
timestamp	string	date-time	No	Timestamp of the forecast
sunrise	string	date-time	Yes	Sunrise time
sunset	string	date-time	Yes	Sunset time
temperature2MetersMin	number	float	Yes	Minimum temperature at 2 meters	°C
temperature2MetersMax	number	float	Yes	Maximum temperature at 2 meters	°C
apparentTemperatureMin	number	float	Yes	Minimum apparent temperature	°C
apparentTemperatureMax	number	float	Yes	Maximum apparent temperature	°C
precipitationSum	number	float	Yes	Total precipitation amount	mm
precipitationHours	number	float	Yes	Number of hours with precipitation	hours
precipitationProbabilityMax	number	float	Yes	Maximum probability of precipitation	%
rainSum	number	float	Yes	Total rain amount	mm
showersSum	number	float	Yes	Total showers amount	mm
snowfallSum	number	float	Yes	Total snowfall amount	cm
weatherCode	integer	int32	Yes	Weather code
windSpeed10MetersMax	number	float	Yes	Maximum wind speed at 10 meters	km/h
windGusts10MetersMax	number	float	Yes	Maximum wind gusts at 10 meters	km/h
windDirection10MetersDominant	number	float	Yes	Dominant wind direction at 10 meters	°
sunshineDuration	number	float	Yes	Sunshine duration in seconds	s
daylightDuration	number	float	Yes	Daylight duration in seconds	s
uvIndexMax	number	float	Yes	Maximum UV index
uvIndexClearSkyMax	number	float	Yes	Maximum UV index under clear sky conditions
et0FaoEvapotranspiration	number	float	Yes	ET0 FAO evapotranspiration	mm
shortwaveRadiationSum	number	float	Yes	Sum of shortwave radiation	MJ/m²

WeatherForecastHourly

Includes hourly weather forecast details.

Property	Type	Format	Nullable	Description	Unit
timestamp	string	date-time	No	Timestamp of the forecast
temperature2Meters	number	float	Yes	Temperature at 2 meters	°C
temperature80Meters	number	float	Yes	Temperature at 80 meters	°C
temperature120Meters	number	float	Yes	Temperature at 120 meters	°C
temperature180Meters	number	float	Yes	Temperature at 180 meters	°C
relativeHumidity2Meters	number	float	Yes	Relative humidity at 2 meters	%
dewPoint2Meters	number	float	Yes	Dew point temperature at 2 meters	°C
apparentTemperature	number	float	Yes	Apparent temperature	°C
precipitation	number	float	Yes	Precipitation amount	mm
precipitationProbability	number	float	Yes	Probability of precipitation	%
rain	number	float	Yes	Rain amount	mm
showers	number	float	Yes	Showers amount	mm
snowfall	number	float	Yes	Snowfall amount	cm
snowDepth	number	float	Yes	Snow depth	cm
weatherCode	integer	int32	Yes	Weather code
visibility	number	float	Yes	Visibility distance	km
windSpeed10Meters	number	float	Yes	Wind speed at 10 meters	km/h
windSpeed80Meters	number	float	Yes	Wind speed at 80 meters	km/h
windSpeed120Meters	number	float	Yes	Wind speed at 120 meters	km/h
windSpeed180Meters	number	float	Yes	Wind speed at 180 meters	km/h
windDirection10Meters	number	float	Yes	Wind direction at 10 meters	°
windDirection80Meters	number	float	Yes	Wind direction at 80 meters	°
windGusts10Meters	number	float	Yes	Wind gusts at 10 meters	km/h
windDirection120Meters	number	float	Yes	Wind direction at 120 meters	°
windDirection180Meters	number	float	Yes	Wind direction at 180 meters	°
isDay	number	float	Yes	Indicates if it is day
sunshineDuration	number	float	Yes	Sunshine duration in seconds	s
cloudCover	number	float	Yes	Cloud cover percentage	%
cloudCoverLow	number	float	Yes	Low-level cloud cover percentage	%
cloudCoverMid	number	float	Yes	Mid-level cloud cover percentage	%
cloudCoverHigh	number	float	Yes	High-level cloud cover percentage	%
pressureMsl	number	float	Yes	Pressure at mean sea level	hPa
surfacePressure	number	float	Yes	Surface pressure	hPa
soilTemperature0Centimeters	number	float	Yes	Soil temperature at 0 centimeters	°C
soilTemperature6Centimeters	number	float	Yes	Soil temperature at 6 centimeters	°C
soilTemperature18Centimeters	number	float	Yes	Soil temperature at 18 centimeters	°C
soilTemperature54Centimeters	number	float	Yes	Soil temperature at 54 centimeters	°C
soilMoisture0CentimetersTo1Centimeters	number	float	Yes	Soil moisture 0-1cm	m³/m³
soilMoisture1CentimetersTo3Centimeters	number	float	Yes	Soil moisture 1-3cm	m³/m³
soilMoisture3CentimetersTo9Centimeters	number	float	Yes	Soil moisture 3-9cm	m³/m³
soilMoisture9CentimetersTo27Centimeters	number	float	Yes	Soil moisture 9-27cm	m³/m³
soilMoisture27CentimetersTo81Centimeters	number	float	Yes	Soil moisture 27-81cm	m³/m³
evapotranspiration	number	float	Yes	Evapotranspiration	mm
vapourPressureDeficit	number	float	Yes	Vapour pressure deficit	kPa
et0FaoEvapotranspiration	number	float	Yes	ET0 Fao Evapotranspiration	mm

WeatherForecastMinutely15

Provides weather data in 15-minute intervals.

Property	Type	Format	Nullable	Description	Unit
timestamp	string	date-time	No	Timestamp of the forecast
temperature2Meters	number	float	Yes	Temperature at 2 meters	°C
relativeHumidity2Meters	number	float	Yes	Relative humidity at 2 meters	%
dewPoint2Meters	number	float	Yes	Dew point temperature at 2 meters	°C
apparentTemperature	number	float	Yes	Apparent temperature	°C
precipitation	number	float	Yes	Precipitation amount	mm
rain	number	float	Yes	Rain amount	mm
showers	number	float	Yes	Showers amount	mm
snowfall	number	float	Yes	Snowfall amount	cm
snowfallHeight	number	float	Yes	Snowfall height	m
freezingLevelHeight	number	float	Yes	Freezing level height	m
sunshineDuration	number	float	Yes	Sunshine duration in seconds	s
weatherCode	integer	int32	Yes	Weather code
cloudCover	number	float	Yes	Cloud cover percentage	%
pressureMsl	number	float	Yes	Pressure at mean sea level	hPa
precipitationProbability	number	float	Yes	Probability of precipitation	%
surfacePressure	number	float	Yes	Surface pressure	hPa
windSpeed10Meters	number	float	Yes	Wind speed at 10 meters	km/h
windSpeed80Meters	number	float	Yes	Wind speed at 80 meters	km/h
windDirection10Meters	number	float	Yes	Wind direction at 10 meters	°
windDirection80Meters	number	float	Yes	Wind direction at 80 meters	°
windGusts10Meters	number	float	Yes	Wind gusts at 10 meters	km/h
visibility	number	float	Yes	Visibility distance	km
lightningPotential	number	float	Yes	Lightning potential
cape	number	float	Yes	CAPE (Convective Available Potential Energy)	J/kg
isDay	boolean		Yes	Indicates if it is day
shortwaveRadiation	number	float	Yes	Shortwave radiation	W/m²
shortwaveRadiationInstant	number	float	Yes	Instantaneous shortwave radiation	W/m²
diffuseRadiation	number	float	Yes	Diffuse radiation	W/m²
diffuseRadiationInstant	number	float	Yes	Instantaneous diffuse radiation	W/m²
directRadiation	number	float	Yes	Direct radiation	W/m²
directRadiationInstant	number	float	Yes	Instantaneous direct radiation	W/m²
terrestrialRadiation	number	float	Yes	Terrestrial radiation	W/m²
terrestrialRadiationInstant	number	float	Yes	Instantaneous terrestrial radiation	W/m²
directNormalIrradiance	number	float	Yes	Direct normal irradiance	W/m²
directNormalIrradianceInstant	number	float	Yes	Instantaneous direct normal irradiance	W/m²
globalTiltedIrradiance	number	float	Yes	Global tilted irradiance	W/m²
globalTiltedIrradianceInstant	number	float	Yes	Instantaneous global tilted irradiance	W/m²

WeatherForecastResponse

The main response object, including copyright information, timezone, current weather, and forecasts.

Property	Type	Nullable	Description
copyright	string	Yes	Copyright information
timezone	string	Yes	Timezone
currently	WeatherForecastCurrently	No	Current weather conditions
minutely15	array of WeatherForecastMinutely15	Yes	Array of minutely (15-minute) forecasts
hourly	array of WeatherForecastHourly	Yes	Array of hourly forecasts
daily	array of WeatherForecastDaily	Yes	Array of daily forecasts
address	Address	No	Address information
errors	array of ServiceError	Yes	Array of service errors

Responses

HTTP Code	Description	Content Type	Schema
200	Success	application/json	WeatherForecastResponse
400	Bad Request	application/json	ProblemDetails
401	Unauthorized	application/json	ProblemDetails
500	Server Error	application/json	ProblemDetails

For more details on the data models and their properties, please refer to the Swagger documentation