Sofar API
Search
⌃K
Comment on page

Variables

Overview

The primary organizational component for all Marine Weather data is referred to as a "variable." Variables can be thought of as the term used to classify all types (e.g. "hindcast," "forecast") of a particular data point. Sofar Ocean uses consistent variable names across all of its Marine Weather API endpoints. Each variable consists of the following four attributes:
  1. 1.
    variableName The canonical name used to identify the variable across all Marine Weather API endpoints
  2. 2.
    variableID A human readable identifier in the format {modelName}-{variableName}
  3. 3.
    physicalUnit The unit of measurement that the variable's values are represented in
  4. 4.
    values An array of predictions or measurements of the variable for a specified moments in time. The structure and contents of this attribute will depend on which data endpoint was used to retrieve data for this variable

Available Variables

Additional information on the available data and their associated models is available via the metadata endpoints for variables and models.
Wave Model
Atmosphere Model
Ocean Model
Variable
significantWaveHeight
meanDirection
meanDirectionalSpread
meanPeriod
peakFrequency
peakDirection
significantWaveHeightWindWaves
meanDirectionWindWaves
meanDirectionalSpreadWindWaves
peakPeriodWindWaves
significantWaveHeightFirstSwell
meanDirectionFirstSwell
meanDirectionalSpreadFirstSwell
peakPeriodFirstSwell
significantWaveHeightSecondSwell
meanDirectionSecondSwell
meanDirectionalSpreadSecondSwell
peakPeriodSecondSwell
significantWaveHeightThirdSwell
meanDirectionThirdSwell
meanDirectionalSpreadThirdSwell
peakPeriodThirdSwell
Variable
windVelocity10MeterEastward
windVelocity10MeterNorthward
Variable
surfaceCurrentVelocityEastward
surfaceCurrentVelocityNorthward
seaSurfaceTemperature
salinity
Previous
Models
Next
Forecast Data
Last modified 7mo ago