Skip to main content

Inventory API

A map inventory contains all maps and features to configure the Maps Plugin.

Static Inventory

Example: https://maps-api.meteoblue.com/v1/map/inventory/{id}?lang={lang}&temperatureUnit={unit}&velocityUnit={unit}&lengthUnit={unit}&energyUnit={unit}&apikey={apikey}

note

A / in the velocityUnit must get encoded to %2F

NameTypeDefaultDescription
idRequiredStringid of the inventory. Currently only weather-maps available
apikeyRequiredString
langOptionalStringentwo chars language code
temperatureUnitOptionalStringCC ≙ celsius, K ≙ kelvin, F ≙ fahrenheit.
velocityUnitOptionalStringkm/hm/s, km/h , mph, kn or bft.
lengthUnitOptionalStringmetricmetric or imperial.
energyUnitOptionalStringwattswatts or joules.
onlyUnrestrictedOptionalBooleanfalsetrue or false.

Filtered Inventory

Example: https://maps-api.meteoblue.com/v1/map/inventory/filter?maps={maps}&overlays={overlays}&lang={lang}&temperatureUnit={unit}&velocityUnit={unit}&lengthUnit={unit}&energyUnit={unit}&apikey={apikey}

NameTypeDefaultDescription
mapsRequiredStringcomma separated list of map names that should be in the inventory.
apikeyRequiredString
overlaysOptionalStringcomma separated list of overlay names that should be in the inventory.
langOptionalStringentwo chars language code
temperatureUnitOptionalStringCC ≙ celsius, K ≙ kelvin, F ≙ fahrenheit.
velocityUnitOptionalStringkm/hm/s, km/h , mph, kn or bft.
lengthUnitOptionalStringmetricmetric or imperial.
energyUnitOptionalStringwattswatts or joules.
onlyUnrestrictedOptionalBooleanfalsetrue or false.

Available Maps

IDTitle
aerosolOpticalDepthAerosol Optical Depth
airQualityIndexAir Quality (CAQI)
apparentTemperatureApparent Temperature
birchPollenBirch Pollen
boundaryLayerHeightBoundary Layer Height
capeCAPE & Lifted Index
cinConvective Inhibition (CIN)
clearAirTurbulendceClear Air Turbulence (CAT)
cloudAltitudeCloud Altitude
cloudsAndPrecipitationClouds & Precipitation
cloudsAndPrecipitationHistoricClouds & Precipitation
coCO
convectiveCloudAltitudeConvective Cloud Altitude
dewpointDewpoint Temperature
dewpointHistoricDewpoint Temperature
dustDesert Dust
et0FAO evapotranspiration (ET0)
evapotranspirationEvapotranspiration
evapotranspirationAnomalyEvapotranspiration Anomaly
extremeForecastIndexExtreme Forecast
freezingLevelFreezing Level Height (0°C)
gph1000thickness1000-500 hPa Thickness
gph1000thicknessHistoric1000-500 hPa Thickness
gph500500 hPa Height
gph500Historic500 hPa Height
gph850temperatureTemperature & Height (GPH)
gph850temperatureHistoricTemperature & Height (GPH)
grassPollenGrass Pollen
gustWind Gust
gustHistoricWind Gust
helicityStorm Helicity (0-3 km)
highCloudsHigh Clouds (>8 km)
hikingHiking Trail Map
humidityRelative Humidity
humidityHistoricRelative Humidity
inFlightIcingIn-Flight Icing
jetstreamJet Stream (250 hPa)
liftedIndexLifted Index
lowCloudsLow Clouds (0-3.5 km)
metarMETAR
midCloudsMedium Clouds (3.5-8 km)
no2NO₂
obsPrecipitationMeasured Precipitation
obsTemperatureMeasured Temperature
oceanCurrentsOcean Currents
olivePollenOlive Pollen
ozoneOzone
particulateMatterParticulate Matter
potentialEvapotranspirationPotential Evapotranspiration
precipAnomalyPrecipitation Anomaly
precipitationHourly Precipitation
precipitationAccumulatedAccumulated Precipitation
precipitationAccumulatedHistoricAccumulated Precipitation
precipitationAnomalyHistoricPrecipitation Anomaly
precipitationDailyDaily Precipitation
precipitationDailyHistoricDaily Precipitation
precipitationHistoricHourly Precipitation
precipitationMonthlyHistoricMonthly Precipitation
precipitationProbabilityPrecipitation Probability
pressurePressure & 3h Tendency
pressureAnomalySea Level Pressure Anomaly
radarWeather Radar
ragweedPollenRagweed Pollen
salinitySea Water Salinity
satelliteSatellite
seaIceCoverSea Ice Cover
seaLevelPressureSea Level Pressure
seaSurfaceTemperatureWater Surface Temperature
sigmetSIGMET
snowHourly Snowfall
snowAccumulatedAccumulated Snowfall
snowDailyDaily Snowfall
snowDepthSnow Depth
snowDepthAnomalySnow Depth Anomaly
so2SO₂
soaringFlightDistanceSoaring Flight Distance
soaringIndexSoaring Index
soilMoistureSoil Moisture
soilMoistureAnomalyHistoricSoil Moisture Anomaly
soilMoistureHistoricSoil Moisture
soilMoistureMonthlyHistoricMonthly Soil Moisture
soilTemperatureSoil Temperature
solarIradiationSolar Radiation (GHI)
sstAnomalySST Anomaly (El Nino)
subseasonalCoolingDegreeDaysProbabilityCDD Probabilities
subseasonalGeopotentialProbability500 mb Geopotential Probabilities
subseasonalHeatingDegreeDaysProbabilityHDD Probabilities
subseasonalPrecipitationProbabilityPreciitation Probabilities
subseasonalPressureProbabilitySea Level Pressure Probabilities
subseasonalRadiationProbabilityShortwave Radiation Probabilities
subseasonalTemperatureProbabilityTemperature Probabilities
subseasonalWindSpeedProbabilityWind speed Probabilities
sunshineSunshine Hours
sunshineHistoricSunshine Hours
surfaceInversionSurface Inversion
temperatureTemperature
temperatureAnomalyTemperature Anomaly (2 m)
temperatureAnomaly850Temperature Anomaly (850 mb)
temperatureAnomalyHistoricTemperature Anomaly (2 m)
temperatureHistoricTemperature
temperatureMeanHistoricMean Temperature (2 m)
temperatureTendencyTemperature Change (Next 24h)
thetaEEquivalent Potential (ThetaE)
totalCloudsCloud Cover Total
updraftConvective Updraft
uvIndexUV Index
vaporDeficitVapor Pressure Deficit
visibilityVisibility
warningsAndRiskWeather Warnings
waveHeightWave Height
wavePeakPeriodWave Peak Period
wavePeriodWave Period
wetbulbPotentialWetbulb Potential Temperature
windWind
windAnimationWind Animation
windConvergenceWind Convergence (10 m)
windHistoricWind
windSpeedAnomalyWind Speed Anomaly

Available Overlays

IDTitle
domainBoundaryDomain Boundaries
graticuleOverlayGraticule
pressure2mOverlaySea Level Pressure
temperatureObsOverlayTemperature OBS
windAnimationOverlayWind Animation

Available Languages

CodeLanguageProgress
arArabicTranslation status
bgBulgarianTranslation status
csCzechTranslation status
deGermanTranslation status
elGreekTranslation status
enEnglishTranslation status
esSpanishTranslation status
frFrenchTranslation status
hrCroatianTranslation status
huHungarianTranslation status
itItalianTranslation status
jaJapaneseTranslation status
kaGeorgianTranslation status
koKoreanTranslation status
nlDutchTranslation status
plPolishTranslation status
ptPortugueseTranslation status
roRomanianTranslation status
ruRussianTranslation status
skSlovakTranslation status
slSloveneTranslation status
srSerbianTranslation status
svSwedishTranslation status
thThaiTranslation status
trTurkishTranslation status
ukUkranianTranslation status
zhChinese (Simplified)Translation status

Note: Further languages may be available upon request. Feedback for improvements or extensions of the translations is highly appreciated.

Examples

  • https://maps-api.meteoblue.com/map/inventory/weather-maps?lang=de&temperatureUnit=C&velocityUnit=km%2Fh&lengthUnit=metric&energyUnit=watts
  • https://maps-api.meteoblue.com/map/inventory/weather-maps?lang=en&temperatureUnit=F&velocityUnit=bft&lengthUnit=imperial&energyUnit=joules
  • https://maps-api.meteoblue.com/map/inventory/weather-maps
  • https://maps-api.meteoblue.com/map/inventory/filter?maps=so2,no2,co&lang=en
  • https://maps-api.meteoblue.com/map/inventory/filter?maps=temperature,wind,precipitation&overlays=pressure2mOverlay&lang=en&temperatureUnit=F&velocityUnit=bft&lengthUnit=imperial&energyUnit=joules