Forecast Data

Overview

Sofar Ocean continually runs forecasts for several marine weather data models and their associated variables. Access to forecasted marine weather conditions at specific geographic locations is made available via the forecast endpoint.

This endpoint allows you to retrieve Sofar Ocean's latest full forecast values for a given pair of latitude and longitude coordinates. The data is organized by model and variable, and it is possible to request forecast data for multiple variables within a single request.

The values associated with each variable will represent the latest 10-day forecast run by Sofar Ocean. In most cases, the returned values will include data values from before the time of the request.

Endpoint

Retrieve forecast data at a geographic location

GET https://api.sofarocean.com/marine-weather/v1/models/:model_id/forecast/point

Returns forecast data from the specified model and variables at a single latitude and longitude point.

Path Parameters

Name	Type	Description
model_id*	string	The ID of the model from which you want to retrieve forecast data

Query Parameters

Name	Type	Description
token*	string	A valid API token
variableIDs*	array	A comma separated list of variable ID strings which you want to retrieve as part of the forecast data. (Limit 3 IDs.) A list of valid variable IDs for any given model can be retrieved from the model metadata endpoint.
longitude*	number	The longitude of the requested forecast point. Can be either positive or negative.
latitude*	number	The latitude of the requested forecast point. Must be between -90 and 90 degrees.

200

400 Missing required parameters

{ "message": "\"longitude\" is required" }

403 A valid API token was not provided or you do not have access to the weather API.

{ "message": "Invalid API token" }

404 The model with the specified ID does not exist or the specified variables do not exist on the model.

{ "message": "Model 'not-a-real-model' does not exist." }
{ "message": "Variable 'not-a-real-variable' does not exist on model 'SofarOperationalWaveModel'" }

422 Used when an invalid value was provided for latitude or too many variable IDs were requested.

{ "message": "Latitude 180 is invalid. Latitude must be between -90 and 90 degrees" }
{ "message": "You can only request at most 3 variableIDs in a single API call" }

Examples

Valid examples and their corresponding responses are available on the Forecast Data examples page.