Weather API
  1. customer
Weather API
  • customer
    • Weather API - General Information
    • Weather API - Variables
    • Weather API - Timesteps
    • Weather API - /wthr/ endpoints usability improvements
    • Weather API - VariableAlias.json
    • Weather API - WeatherVariablesDefaults.json
    • Weather API - weatherMap - parameters
    • Weather API - weatherTiles - general, zoom
    • Weather API - weatherTiles - weather variables
    • Weather API - weatherTiles - timesteps
    • /
      GET
    • /wthr/list/ForecastModels
      GET
    • /wthr/list/WeatherVariables
      GET
    • /wthr/list/Timesteps
      GET
    • /wthr/list/TileTimesteps
      GET
    • /wthr/svar/NearestGridData
      GET
    • /wthr/svar/InterpolatedData
      GET
    • /wthr/svar/AreaForcast
      GET
    • /wthr/mvar/PointForcast
      POST
    • /wthr/calc/AstroData
      GET
    • /wthr/graphic/Meteogram
      GET
    • /wthr/graphic/WeatherMap
      GET
    • /wthr/graphic/Tile
      GET
  1. customer

Weather API - WeatherVariablesDefaults.json

Weather Model Configurations#

This document outlines the available weather models and their respective variables, including details such as aliases, full names, units, and available levels.

Model: gfs#

Default Model: Yes
VariableIs Default VariableVariable Alias(es)Full NameUnitAvailable LevelsLevel Alias(es)
4LFTXfalseBest (4 layer) Lifted IndexKsurface
APTMPfalseApparent Temperature°C2 m above ground
CAPEfalseConvective Available Potential EnergyJ/kgsurface
CFRZRfalseCategorical Freezing Rain1 = truesurface
CICEPfalseCategorical Ice Pellets1 = truesurface
CRAINfalseRegenCategorical Rain1 = truesurface
CSNOWfalseCategorical Snow1 = truesurface
DLWRFfalseDownward Long-Wave Rad. FluxW/m²surface
DPTfalseTaupunktDew Point Temperature°C2 m above ground
DSWRFfalseDownward Short-Wave Radiation FluxW/m²surface
GUSTfalseWind Speed (Gust)m/ssurface
HCDCfalseHigh Cloud Cover%high cloud layer
HINDEXfalseHaines Indexsurface
ICECfalseIce Cover%surface
ICEGfalseIce Growth Ratemm/h10 m above mean sea level
ICETKfalseIce Thicknessmsurface
ICETMPfalseIce Temperature°Csurface
LANDfalseLand Cover (0=sea, 1=land)1 = truesurface
LCDCfalseLow Cloud Cover%low cloud layer
MCDCfalseMedium Cloud Cover%middle cloud layer
PRATEfalsePrecipitation Ratemm/hsurface
PRMSLfalsePressure Reduced to MSLhPamean sea level
RHfalseRelative Humidity%2 m above ground
SNODfalseSnow Depthmsurface
SOILWfalseVolumetric Soil Moisture Content%0-0.1 m underground, 0.1-0.4 m underground, 0.4-1 m underground, 1-2 m underground
SOTYPfalseSoil Typesurface
SUNSDfalseSunshine Durationhsurface
TCDCfalseTotal Cloud Cover%entire atmosphere
TMPtrueTemperaturTemperature°C2 m above ground, surface2 m above ground -> 2m, 2 m above ground -> 2 m
TSOILfalseSoil Temperature (Parameter Deprecated, see Note 3)°C0-0.1 m underground, 0.1-0.4 m underground, 0.4-1 m underground, 1-2 m underground
UGRDfalseU-Component of Windm/s10 m above ground
ULWRFfalseUpward Long-Wave Rad. FluxW/m²surface
USWRFfalseUpward Short-Wave Radiation FluxW/m²surface
VEGfalseVegetation%surface
VGRDfalseV-Component of Windm/s10 m above ground
VISfalseVisibilitymsurface

Model: gfswave#

Default Model: false
VariableIs Default VariableVariable Alias(es)Full NameUnitAvailable LevelsLevel Alias(es)
DIRPWfalsePrimary Wave Direction°surface
HTSGWfalseSignificant Height of Combined Wind Waves and Swellmsurface
PERPWfalsePrimary Wave Mean Periodssurface
SWDIRfalseDirection of Swell Waves°1 in sequence, 2 in sequence, 3 in sequence
SWELLfalseSignificant Height of Swell Wavesm1 in sequence, 2 in sequence, 3 in sequence
SWPERfalseMean Period of Swell Wavess1 in sequence, 2 in sequence, 3 in sequence
UGRDfalseU-Component of Windm/ssurfacesurface -> 10m, surface -> 10 m, surface -> 10 m above ground
VGRDfalseV-Component of Windm/ssurfacesurface -> 10m, surface -> 10 m, surface -> 10 m above ground
WDIRfalseWind Direction (from which blowing)°surfacesurface -> 10m, surface -> 10 m, surface -> 10 m above ground
WINDtrueWind Speedm/ssurfacesurface -> 10m, surface -> 10 m, surface -> 10 m above ground
WVDIRfalseDirection of Wind Waves°surface
WVHGTfalseSignificant Height of Wind Wavesmsurface
WVPERfalseMean Period of Wind Wavesssurface

Model: rtofs_prog#

Default Model: false
VariableIs Default VariableVariable Alias(es)Full NameUnitAvailable LevelsLevel Alias(es)
PRACTSALfalsePractical Salinityg/kgsurface
UOGRDfalseU-Component of Currentm/s0.01 mb
VOGRDfalseV-Component of Currentm/s0.01 mb
WATPDENAfalseWater potential density anomaly (sigma theta)kg/m³0.01 mb
WTMPtrueWater Temperature°Csurface

Model: rtofs_ice#

Default Model: false
VariableIs Default VariableVariable Alias(es)Full NameUnitAvailable LevelsLevel Alias(es)
ICECfalseIce Cover%surface
ICETKfalseIce Thicknessmsurface
ICETMPtrueIce Temperature°Csurface
UICEfalseU-Component of Ice Driftm/ssurface
VICEfalseV-Component of Ice Driftm/ssurface

Modified at 2025-05-30 18:57:03
Previous
Weather API - VariableAlias.json
Next
Weather API - weatherMap - parameters
Built with