Requesting forecast by geometry - Xweather Protect, Xweather Optimize, Xweather Observe

Vaisala Xweather Protect, Xweather Optimize, and Xweather Observe Forecast by Geometry API Reference
Product status
Document code
M213289EN
Revision
B
ft:locale
en-US
Product
Xweather Protect, Xweather Optimize, Xweather Observe
Document type
Technical description

You can query the API to get condition from any point across the globe.

Request

The following is a cURL example of making a request with GET.

curl -L -X GET 'https://api.eu.platform.xweather.com/forecast-manager/forecast' \
-H 'Accept: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>'
Parameters
Parameter Description Example
geometry Latitude and longitude of the point. 13.253,15.6
lon Longitude of the point. 13.253
lat Latitude of the point. 15.6
weather_params Weather parameters.
  • accumulated_precipitation - Amount of accumulated precipitation in mm for hourly and daily period requests. If the request is made for a subhourly request (by default 15 min) the response is given in mm/h representing the intensity of rain.
  • air_temperature - Air temperature at 2 m in Celsius.
  • air_temperature_max - Maximum air temperature at 2 m in Celsius per calendar day.
  • air_temperature_min - Minimum air temperature at 2 m in Celsius per calendar day.
  • air_pressure - Mean sea level pressure in hPa.
  • feeling_temperature - Feels like temperature at 2 m in Celsius.
  • probability_precipitation - Probability of trace amount of precipitation.
  • relative_humidity - Relative humidity at 2 m in percentage.
  • solar_radiation - Solar radiation in W/m^2 for subhourly and hourly and total amount of energy generated or consumed during the day in Wh/m^2.
  • uv_index - The UV index, also known as the ultraviolet index, serves as an internationally recognized standard for gauging the intensity of sunburn-inducing ultraviolet (UV) radiation at specific locations and times.
  • wind_direction - Wind direction at 10 m.
  • wind_speed - 10 minute average wind speed at 10 m.
  • wind_speed_max - Max of 10 minute average wind speed at 10 m.
 wind_speed,air_temperature
aq_params Air quality parameters.
  • air_quality_index - Air quality index in local categories (USA EPA AirNow (default), European AQI (EAQI), CHN-AQ, IND-AQI, South Korea AQI (CAI), Germany UBA Daily AQI, UK DAQI).
  • carbon_monoxide - Carbon monoxide pollutant.
  • health_index - Air quality health index.
  • nitrogen_dioxide -Nitrogen dioxide pollutant.
  • ozone - Ozone pollutant.
  • particle_matter_2_5 - Particle matter pollutant (<2.5 µm).
  • particle_matter_10 - Particle matter pollutant (<10 µm).
  • sulfur_dioxide - Sulfur dioxide pollutant.
 ozone,air_quality_index
period Time series period.
  • daily - Get daily step.
  • hourly - Get hourly step.
  • subhourly - Get subhourly step (15 minutes interval).

Authorization

name: X-API-KEY
type: apiKey
in: header
description: API Key for authentication