Skip to main content

Platform Variables

A comprehensive list of all variables available across the API Platform.

Variable NameAPI SourceUnitDescription
air.humidity.at-2mPoint Forecast API%, percentRelative humidity 2 meters above ground level.
air.pressure.at-sea-levelPoint Forecast APIPa, pascalAir pressure at sea level is the quantity often abbreviated as MSLP or PMSL. Air pressure is the force per unit area which would be exerted when the m...
air.temperature.at-2mPoint Forecast APIK, Degrees KelvinAir temperature is the bulk temperature of the air, not the surface (skin) temperature.
air.visibilityPoint Forecast APIm, meterThe visibility is the distance at which something can be seen.
air_temperatureNowcast APICelsiusAir temperature. Null if data is unavailable.
atmosphere.convective.potential.energyPoint Forecast APIJ/kg, joules per kilogramIntegrated amount of work that the upward (positive) buoyancy force would perform on a given mass of air (called an air parcel) if it rose vertically ...
cloud.base.heightPoint Forecast APIm, meterA cloud base (or the base of the cloud) is the lowest altitude of the visible portion of a cloud. Cloud base refers to the base of the lowest cloud. H...
cloud.coverPoint Forecast API%, percentTotal cloud cover in the atmosphere column. "Area fraction" is the fraction of a grid cell's horizontal area that has some characteristic of interest....
current.speed.eastward.at-sea-surfacePoint Forecast APIm/s, meters per second“Surface" means the lower boundary of the atmosphere. A velocity is a vector quantity. "Eastward" indicates a vector component which is positive when ...
current.speed.eastward.at-sea-surface-no-tidePoint Forecast APIm/s, meters per secondThe surface called 'surface' means the lower boundary of the atmosphere. 'Water' means water in all phases, including frozen i.e. ice and snow. A velo...
current.speed.eastward.barotropicPoint Forecast APIm/s, meters per secondAverage current over the full water column / to the bottom of the sea. A velocity is a vector quantity. "Eastward" indicates a vector component which ...
current.speed.eastward.barotropic-no-tidePoint Forecast APIm/s, meters per secondA velocity is a vector quantity. 'Eastward' indicates a vector component which is positive when directed eastward (negative westward).
current.speed.northward.at-sea-surfacePoint Forecast APIm/s, meters per second"Surface" means the lower boundary of the atmosphere. A velocity is a vector quantity. "Northward" indicates a vector component which is positive when...
current.speed.northward.at-sea-surface-no-tidePoint Forecast APIm/s, meters per secondThe surface called 'surface' means the lower boundary of the atmosphere. 'Water' means water in all phases, including frozen i.e. ice and snow. A velo...
current.speed.northward.barotropicPoint Forecast APIm/s, meters per secondAverage current over the full water column / to the bottom of the sea. A velocity is a vector quantity. "Northward" indicates a vector component which...
current.speed.northward.barotropic-no-tidePoint Forecast APIm/s, meters per secondA velocity is a vector quantity. 'Northward' indicates a vector component which is positive when directed northward (negative southward).
precipitation.ratePoint Forecast APImm/hr, millimeters per hour'Precipitation' in the earth's atmosphere means precipitation of water in all phases. The abbreviation 'lwe' means liquid water equivalent. 'Precipita...
radiation.flux.downward.longwavePoint Forecast APIW/m^2, irradiance, or radiant flux densityThe surface called 'surface' means the lower boundary of the atmosphere. 'longwave' means longwave radiation. 'Downward' indicates a vector component ...
radiation.flux.downward.shortwavePoint Forecast APIW/m^2, irradiance, or radiant flux densityThe surface called 'surface' means the lower boundary of the atmosphere. 'shortwave' means shortwave radiation. 'Downward' indicates a vector componen...
sea.temperature.at-surfacePoint Forecast APIK, Degrees KelvinSea surface temperature is usually abbreviated as "SST". It is the temperature of sea water near the surface (including the part under sea-ice, if any...
sea.temperature.at-surface-anomalyPoint Forecast APIK, Degrees KelvinThe term 'anomaly' means difference from climatology. Sea surface temperature is usually abbreviated as 'SST'. It is the temperature of sea water near...
sea_surface_height_above_mean_sea_levelTide API-Tidal elevation in meters.
tidal_stageTide API-Indicates whether the turning point is a High Water or Low Water....
wave.direction.above-8s.peakPoint Forecast API°, degreeSpectral peak direction of the portion of a wave frequency spectrum where periods are above 8s. Direction from which the most energetic waves are comi...
wave.direction.below-8s.peakPoint Forecast API°, degreeSpectral peak direction of the portion of a wave frequency spectrum where periods are below 8s. Direction from which the most energetic waves are comi...
wave.direction.meanPoint Forecast API°, degreeMean wave direction of where the waves are coming from
wave.direction.peakPoint Forecast API°, degreeSpectral peak direction of the total sea state. The direction from which the most energetic waves are coming. The spectral peak is the most energetic ...
wave.directional-spreadPoint Forecast API°, degreeDirectional spread is the (one-sided) directional width within a given sub-domain of the wave directional spectrum, S(t,x,y,f,theta) where t is time, ...
wave.heightPoint Forecast APIm, meterSignificant wave height, which is the average height of the highest one third of the waves for the location. The height is defined as the vertical dis...
wave.height.above-8sPoint Forecast APIm, meterSwell waves are waves on the ocean surface and are the low frequency portion of a bimodal wave frequency spectrum. Significant wave height is a statis...
wave.height.below-8sPoint Forecast APIm, meterSignificant wave height of wind seas. It is computed from the portion of a wave frequency spectrum where periods are below 8s. Wind waves are waves on...
wave.height.maxPoint Forecast APIm, meterMaximum wave height, which is the height of the largest single wave at the location.
wave.period.above-8s.peakPoint Forecast APIs, secondPeriod of the most energetic waves within the swell wave component of a sea. Swell waves are waves on the ocean surface and are the low frequency port...
wave.period.below-8s.peakPoint Forecast APIs, secondPeriod of the most energetic waves within the wind wave component of a sea. Wind waves are waves on the ocean surface and are the high frequency porti...
wave.period.peakPoint Forecast APIs, secondA period is an interval of time, or the time-period of an oscillation. Also called peak wave period, is the period of the most energetic waves in the ...
wave.period.tm01.meanPoint Forecast APIs, secondTm01 is mean wave period using the zeroth- and first-order moments = m0/m1. Tm01 is less dependent on the high-frequency part of the spectrum, it is u...
wave.period.tm02.meanPoint Forecast APIs, secondTm02 is mean wave period using the zeroth- and second-order moments = sqrt(m0/m2). Tm02 gives the closest result to the mean period obtained with the ...
wind.direction.at-100mPoint Forecast API°, degreeThe direction from which it is blowing at 100 meters above ground. North = 360, east = 90 and 0 means no wind / clam
wind.direction.at-10mPoint Forecast API°, degreeThe direction from which it is blowing at 10 meters above ground. North = 360, east = 90 and 0 means no wind / clam
wind.speed.at-100mPoint Forecast APIm/s, meters per secondWind speed at 10m above ground level
wind.speed.at-10mPoint Forecast APIm/s, meters per secondWind speed at 10m above ground level
wind.speed.eastward.at-100mPoint Forecast APIm/s, meters per secondEastward wind speed vector component which is positive when directed eastward (negative westward). At 10 meters (or 100 meters) above ground level.
wind.speed.eastward.at-10mPoint Forecast APIm/s, meters per secondEastward wind speed vector component which is positive when directed eastward (negative westward). At 10 meters (or 100 meters) above ground level.
wind.speed.gust.at-10mPoint Forecast APIm/s, meters per secondThe speed of wind gusts.
wind.speed.northward.at-100mPoint Forecast APIm/s, meters per secondNorthward wind speed vector component which is positive when directed northward (negative southward). At 10 meters (or 100 meters) above ground level.
wind.speed.northward.at-10mPoint Forecast APIm/s, meters per secondNorthward wind speed vector component which is positive when directed northward (negative southward). At 10 meters (or 100 meters) above ground level.
wind_from_directionNowcast APIdegreesWind direction (degrees true). Null if data is unavailable.
wind_speedNowcast APIkm/hWind speed. Null if data is unavailable.