Data Conventions

The API returns data in JSON format with the following structure:

• coordinates:
  • latitude
  • longitude
  • timestamp
• 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:

  • For currents:
    • Currents_Intensity (m/s)
    • Currents_Direction (degrees, where 0° is TO the North)
  • For wind:
    • Winds_10m_Intensity (m/s)
    • Winds_10m_Direction (degrees, where 0° is FROM the North)
  • For wave:
    • Waves_Significant_Height (meters)
    • Waves_Mean_Period (seconds)
    • Waves_Mean_Direction (degrees, where 0° is FROM the North)
  • For extra_wave:
    • Swell_Wave_Significant_Height (meters)
    • Swell_Wave_Mean_Period (seconds)
    • Swell_Wave_Mean_Direction (degrees, where 0° is FROM the North)
    • Wind_Wave_Significant_Height (meters)
    • Wind_Wave_Mean_Period (seconds)
    • Wind_Wave_Mean_Direction (degrees, where 0° is FROM the North)
  • For sst:
    • Sea_Surface_Temperature (°C)
  • For bathy:
    • Bathymetry (meters below sea level)
  • For gust:
    • Gust_10m (m/s)

• 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.