Models

Overview

Sofar Ocean organizes its marine weather data according to the model that was used to generate it. Internally, we run various models to generate the most accurate forecast possible. When exposing these outputs via our API, we organize them based on the forecast model they are associated with: Wave, Atmosphere, or Ocean.

Each model has different variables it provides data for. A comprehensive list of these variables is available here.

Metadata Endpoints

In addition to the data-related endpoints (forecast, hindcast, and map tiles), Sofar Ocean also provides several endpoints to quickly understand what models you currently have access to.

List metadata for available data models

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

Returns a list of all available weather data models and associated metadata that your token is authorized to access.

Query Parameters

Name	Type	Description
token*	String	A valid API token

200: OK

403: Forbidden A valid API token was not provided or you do not have access to weather data

{ "message": "Invalid API token" }

List metadata for specific data model

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

Returns metadata for a single weather data model, including a list of variables and data categories that the model outputs.

Path Parameters

Name	Type	Description
model_id*	String	The ID of the model for which you want to retrieve metadata

Query Parameters

Name	Type	Description
token*	String	A valid API token

200: OK

403: Forbidden A valid API token was not provided or you do not have access to weather data

{ "message": "Invalid API token" }

404: Not Found The requested model does not exist

{ "message": "Model 'bad-model' does not exist" }

Examples

Valid examples and their corresponding responses are available on the Model Metadata examples page.