Model Metadata
Working examples of interacting with the Models marine weather endpoints.
List metadata for available data models
Example request
curl "https://api.sofarocean.com/marine-weather/v1/models?token=YOUR_API_TOKEN_HERE"Response
{
"models": [
{
"modelID": "Wave",
"description": "This is the output of Sofar's assimilated operational wave forecast model forced by ECMWF atmospheric forecasts.",
"outputTimes": {
"frequencyHours": 1,
"offset": 0
},
"dataTypes": [
"forecast",
"hindcast"
],
"variables": [
{
"variableID": "Wave-significantWaveHeight",
"variableName": "significantWaveHeight",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"dataRange": [
0,
15
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirection",
"variableName": "meanDirection",
"defaultPhysicalUnit": "degree",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionalSpread",
"variableName": "meanDirectionalSpread",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanPeriod",
"variableName": "meanPeriod",
"defaultPhysicalUnit": "s",
"rasterTiles": {
"dataRange": [
0.5,
15
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-peakFrequency",
"variableName": "peakFrequency",
"defaultPhysicalUnit": "hz",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-peakDirection",
"variableName": "peakDirection",
"defaultPhysicalUnit": "degree",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-significantWaveHeightWindWaves",
"variableName": "significantWaveHeightWindWaves",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"dataRange": [
0,
15
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionWindWaves",
"variableName": "meanDirectionWindWaves",
"defaultPhysicalUnit": "degree",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionalSpreadWindWaves",
"variableName": "meanDirectionalSpreadWindWaves",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-peakPeriodWindWaves",
"variableName": "peakPeriodWindWaves",
"defaultPhysicalUnit": "s",
"rasterTiles": {
"dataRange": [
0.75,
20
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-significantWaveHeightFirstSwell",
"variableName": "significantWaveHeightFirstSwell",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"dataRange": [
0,
15
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionFirstSwell",
"variableName": "meanDirectionFirstSwell",
"defaultPhysicalUnit": "degree",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionalSpreadFirstSwell",
"variableName": "meanDirectionalSpreadFirstSwell",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-peakPeriodFirstSwell",
"variableName": "peakPeriodFirstSwell",
"defaultPhysicalUnit": "s",
"rasterTiles": {
"dataRange": [
1,
25
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-significantWaveHeightSecondSwell",
"variableName": "significantWaveHeightSecondSwell",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"dataRange": [
0,
15
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionSecondSwell",
"variableName": "meanDirectionSecondSwell",
"defaultPhysicalUnit": "degree",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionalSpreadSecondSwell",
"variableName": "meanDirectionalSpreadSecondSwell",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-peakPeriodSecondSwell",
"variableName": "peakPeriodSecondSwell",
"defaultPhysicalUnit": "s",
"rasterTiles": {
"dataRange": [
1,
25
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-significantWaveHeightThirdSwell",
"variableName": "significantWaveHeightThirdSwell",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"dataRange": [
0,
15
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionThirdSwell",
"variableName": "meanDirectionThirdSwell",
"defaultPhysicalUnit": "degree",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-meanDirectionalSpreadThirdSwell",
"variableName": "meanDirectionalSpreadThirdSwell",
"defaultPhysicalUnit": "m",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Wave-peakPeriodThirdSwell",
"variableName": "peakPeriodThirdSwell",
"defaultPhysicalUnit": "s",
"rasterTiles": {
"dataRange": [
1,
25
],
"available": false
},
"json": {
"available": true
}
}
]
},
{
"modelID": "Atmosphere",
"description": "This is the post-processed output from the ECMWF Atmospheric Model.",
"outputTimes": {
"frequencyHours": 1,
"offset": 0
},
"dataTypes": [
"forecast",
"hindcast"
],
"variables": [
{
"variableID": "Atmosphere-windVelocity10MeterEastward",
"variableName": "windVelocity10MeterEastward",
"defaultPhysicalUnit": "m/s",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Atmosphere-windVelocity10MeterNorthward",
"variableName": "windVelocity10MeterNorthward",
"defaultPhysicalUnit": "m/s",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
}
]
},
{
"modelID": "Ocean",
"description": "This is the unaltered output from the HYCOM consortium's HYCOM circulation model.",
"outputTimes": {
"frequencyHours": 3,
"offset": 0
},
"dataTypes": [
"forecast",
"hindcast"
],
"variables": [
{
"variableID": "Ocean-seaSurfaceTemperature",
"variableName": "seaSurfaceTemperature",
"defaultPhysicalUnit": "Celsius degree",
"rasterTiles": {
"dataRange": [
-3,
35
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Ocean-surfaceCurrentVelocityEastward",
"variableName": "surfaceCurrentVelocityEastward",
"defaultPhysicalUnit": "m/s",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Ocean-surfaceCurrentVelocityNorthward",
"variableName": "surfaceCurrentVelocityNorthward",
"defaultPhysicalUnit": "m/s",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Ocean-salinity",
"variableName": "salinity",
"defaultPhysicalUnit": "psu",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
}
]
}
]
}List metadata for specific data model
Example request
curl "https://api.sofarocean.com/marine-weather/v1/models/Ocean?token=YOUR_API_TOKEN_HERE"Response
{
"modelID": "Ocean",
"description": "This is the unaltered output from the HYCOM consortium's HYCOM circulation model.",
"outputTimes": {
"frequencyHours": 3,
"offset": 0
},
"dataTypes": [
"forecast",
"hindcast"
],
"variables": [
{
"variableID": "Ocean-seaSurfaceTemperature",
"variableName": "seaSurfaceTemperature",
"defaultPhysicalUnit": "Celsius degree",
"rasterTiles": {
"dataRange": [
-3,
35
],
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Ocean-surfaceCurrentVelocityEastward",
"variableName": "surfaceCurrentVelocityEastward",
"defaultPhysicalUnit": "m/s",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Ocean-surfaceCurrentVelocityNorthward",
"variableName": "surfaceCurrentVelocityNorthward",
"defaultPhysicalUnit": "m/s",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
},
{
"variableID": "Ocean-salinity",
"variableName": "salinity",
"defaultPhysicalUnit": "psu",
"rasterTiles": {
"available": false
},
"json": {
"available": true
}
}
]
}Last updated