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

Name		Type	Default	Description
id	Required	String		id of the inventory. Currently only weather-maps available
apikey	Required	String
lang	Optional	String	en	two chars language code
temperatureUnit	Optional	String	C	C ≙ celsius, K ≙ kelvin, F ≙ fahrenheit.
velocityUnit	Optional	String	km/h	m/s, km/h , mph, kn or bft.
lengthUnit	Optional	String	metric	metric or imperial.
energyUnit	Optional	String	watts	watts or joules.
onlyUnrestricted	Optional	Boolean	false	true 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}

Name		Type	Default	Description
maps	Required	String		comma separated list of map names that should be in the inventory.
apikey	Required	String
overlays	Optional	String		comma separated list of overlay names that should be in the inventory.
lang	Optional	String	en	two chars language code
temperatureUnit	Optional	String	C	C ≙ celsius, K ≙ kelvin, F ≙ fahrenheit.
velocityUnit	Optional	String	km/h	m/s, km/h , mph, kn or bft.
lengthUnit	Optional	String	metric	metric or imperial.
energyUnit	Optional	String	watts	watts or joules.
onlyUnrestricted	Optional	Boolean	false	true or false.

Available Maps

ID	Title
aerosolOpticalDepth	Aerosol Optical Depth
airQualityIndex	Air Quality (CAQI)
apparentTemperature	Apparent Temperature
birchPollen	Birch Pollen
boundaryLayerHeight	Boundary Layer Height
cape	CAPE & Lifted Index
cin	Convective Inhibition (CIN)
clearAirTurbulendce	Clear Air Turbulence (CAT)
cloudAltitude	Cloud Altitude
cloudsAndPrecipitation	Clouds & Precipitation
co	CO
convectiveCloudAltitude	Convective Cloud Altitude
dewpoint	Dewpoint Temperature
dust	Desert Dust
et0	FAO evapotranspiration (ET0)
evapotranspiration	Evapotranspiration
evapotranspirationAnomaly	Evapotranspiration Anomaly
extremeForecastIndex	Extreme Forecast
freezingLevel	Freezing Level Height (0°C)
gph1000thickness	1000-500 hPa Thickness
gph500	500 hPa Height
gph850temperature	Temperature & Height (GPH)
grassPollen	Grass Pollen
gust	Wind Gust
helicity	Storm Helicity (0-3 km)
highClouds	High Clouds (>8 km)
hiking	Hiking Trail Map
humidity	Relative Humidity
inFlightIcing	In-Flight Icing
jetstream	Jet Stream (250 hPa)
liftedIndex	Lifted Index
lowClouds	Low Clouds (0-3.5 km)
metar	METAR
midClouds	Medium Clouds (3.5-8 km)
no2	NO₂
obsPrecipitation	Measured Precipitation
obsTemperature	Measured Temperature
oceanCurrents	Ocean Currents
olivePollen	Olive Pollen
ozone	Ozone
particulateMatter	Particulate Matter
potentialEvapotranspiration	Potential Evapotranspiration
precipAnomaly	Precipitation Anomaly
precipitation	Hourly Precipitation
precipitationAccumulated	Accumulated Precipitation
precipitationDaily	Daily Precipitation
precipitationProbability	Precipitation Probability
pressure	Pressure & 3h Tendency
pressureAnomaly	Sea Level Pressure Anomaly
radar	Weather Radar
ragweedPollen	Ragweed Pollen
salinity	Sea Water Salinity
satellite	Satellite
seaIceCover	Sea Ice Cover
seaLevelPressure	Sea Level Pressure
seaSurfaceTemperature	Water Surface Temperature
sigmet	SIGMET
snow	Hourly Snowfall
snowAccumulated	Accumulated Snowfall
snowDaily	Daily Snowfall
snowDepth	Snow Depth
snowDepthAnomaly	Snow Depth Anomaly
so2	SO₂
soaringFlightDistance	Soaring Flight Distance
soaringIndex	Soaring Index
soilMoisture	Soil Moisture
soilTemperature	Soil Temperature
solarIradiation	Solar Radiation (GHI)
sstAnomaly	SST Anomaly (El Nino)
sunshine	Sunshine Hours
surfaceInversion	Surface Inversion
temperature	Temperature
temperatureAnomaly	Temperature Anomaly (2 m)
temperatureAnomaly850	Temperature Anomaly (850 mb)
temperatureHistoric	Temperature
temperatureTendency	Temperature Change (Next 24h)
thetaE	Equivalent Potential (ThetaE)
totalClouds	Cloud Cover Total
updraft	Convective Updraft
uvIndex	UV Index
vaporDeficit	Vapor Pressure Deficit
visibility	Visibility
warningsAndRisk	Weather Warnings
waveHeight	Wave Height
wavePeakPeriod	Wave Peak Period
wavePeriod	Wave Period
wetbulbPotential	Wetbulb Potential Temperature
wind	Wind
windAnimation	Wind Animation
windConvergence	Wind Convergence (10 m)
windSpeedAnomaly	Wind Speed Anomaly

Available Overlays

ID	Title
domainBoundary	Domain Boundaries
graticuleOverlay	Graticule
pressure2mOverlay	Sea Level Pressure
temperatureObsOverlay	Temperature OBS
windAnimationOverlay	Wind Animation

Available Languages

Code	Language	Progress
ar	Arabic
bg	Bulgarian
cs	Czech
de	German
el	Greek
en	English
es	Spanish
fr	French
hu	Hungarian
it	Italian
ja	Japanese
ka	Georgian
ko	Korean
nl	Dutch
pl	Polish
pt	Portuguese
ro	Romanian
ru	Russian
sk	Slovak
sr	Serbian
sv	Swedish
th	Thai
tr	Turkish
zh	Chinese (Simplified)

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