Hindcast Data

Overview

Sofar Ocean provides access to its hindcast data for historical analyses. Hindcast data is historical forecast data that reflects the most accurate prediction Sofar Ocean generated for this time period.

The hindcast endpoint can be used to retrieve historical data at specific geographic locations. It returns data for variables from a specified model at a single latitude and longitude point at a single point in time or within a defined time range.

Endpoint

Retrieve hindcast data for time range at a geographic location

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

Returns hindcast data for variables from a specified model at a single latitude and longitude point for a defined time range (based on the provided start and end query parameters).

Path Parameters

Name	Type	Description
model_id*	string	The ID of the model from which you want to retrieve hindcast 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 hindcast point. Can be either positive or negative.
latitude*	number	The latitude of the requested hindcast point. Must be between -90 and 90 degrees.
start	string	The beginning of the requested time frame. May be used with end to define a time range instead of a single timestamp. Must be a valid ISO 8601 timestamp in UTC.
end	string	The end of the requested time frame. May be used with start to define a time range instead of a single timestamp. Must be a valid ISO 8601 timestamp in UTC and greater than or equal to the requested start.

200

400 The request parameters were invalid.

{ "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 in 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.

{ "message": "Latitude 180 is invalid. Latitude must be between -90 and 90 degrees" }

Retrieve hindcast data for a single point in time at a geographic location

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

Returns hindcast data for variables from a specified model at a single latitude and longitude point for a single point in time.

Path Parameters

Name	Type	Description
model_id*	string	The ID of the model from which you want to retrieve hindcast 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 hindcast point. Can be either positive or negative.
latitude*	number	The latitude of the requested hindcast point. Must be between -90 and 90 degrees.
timestamp	string	The point in time to query for. May be used in place of a time range (start and end). Must be a valid ISO 8601 timestamp in UTC.

200

400 The request parameters were invalid.

{ "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 in 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.

{ "message": "Latitude 180 is invalid. Latitude must be between -90 and 90 degrees" }

Examples

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