Data Conventions
The API returns data in JSON format with the following structure:
- coordinates:
latitudelongitudetimestamp
- conditions: The MetOcean conditions requested by the payload (see list in conventions below)
Conventions
IMPORTANT: Direction conventions differ between parameters:
- Currents: Direction indicates where the current is flowing TO
- Winds and Waves: Direction indicates where they are coming FROM
The direction is given in degrees, starting from 0° in the North and increasing clockwise. For example: - A wind direction of 90° means the wind is coming FROM the East - A current direction of 90° means the current is flowing TO the East
This distinction is critical for navigation and operational planning.
-
MetOcean conditions:
There is no naming rule connecting a requested variable's name to the key(s) it produces — the table below is the authoritative mapping.
Requested variablesvalueKey(s) returned in conditionsUnit currentCurrents_Intensity,Currents_Directionm/s, degrees (0° = North, TO) windWinds_{wind_height}m_Intensity,Winds_{wind_height}m_Direction— named after the request'swind_height(default10, e.g.Winds_10m_Intensity)m/s, degrees (0° = North, FROM) gustGust_10mm/s waveWaves_Significant_Height,Waves_Mean_Period,Waves_Mean_Directionmeters, seconds, degrees (FROM) extra_waveSwell_Significant_Height,Swell_Mean_Period,Swell_Mean_Direction,Windwaves_Significant_Height,Windwaves_Mean_Period,Windwaves_Mean_Directionmeters, seconds, degrees (FROM) sstSea_Surface_Temperature°C bathyBathymetrymeters below sea level rainPrecipitationkg·m⁻²·h⁻¹ (i.e. mm/h) mucapeMUCAPEJ/kg tempTemperature_2m°C cloudCloud_Cover% pressurePressurehPa Requesting
extra_wavereturns all six swell/windwave keys at once — there is no way to request swell or wind-wave data independently. -
timestamp:
The UTC timestamp for the data point.
Note: If data is missing or invalid, the corresponding value may be returned as null or None.
Note: Depending on the data source (Hindcast-3Y, Hindcast-3M, or Forecast), some parameters may have slightly different names or availability. See the Models section for details on data sources.