Search (Beta)
The /search url communicates data collected from all accessible Spotter's wave sensors within a specified geospatial area and date-time window.
Search
GET
https://api.sofarocean.com/api/search
* This is a beta API. All input and output parameters are subject to change without notice. Returns all data types from all accessible devices within the specified geospatial area and date-time window.
Query Parameters
shape
string
The shape of the geospatial area to search. Select one of the following: - circle - envelope
shapeParams
array
A comma-separated array of coordinates going by the [lat, lon] format. Latitudes and longitudes must be SRID 4326 compliant. Example: 1,-1,2,-2 would translate to (1, -1), (2, -2)
startDate
string
Timestamp indicating the start date for data inclusion. Must be a ISO 8601 formatted string
Example: 2021-01-01T00:00:00Z
endDate
string
Timestamp indicating the start date for data inclusion. Must be a ISO 8601 formatted string
Example: 2021-02-01T00:00:00Z
pageSize
integer
The desired number of samples returned at once
Default: 500
radius
number
Radius (in meters) of geospatial area to query.
Only used if shape=circle
This parameter is required if shape=circle
{
"data": [
{
"timestamp": "2021-01-01T00:00:00Z",
"latitude": 37.777777,
"longitude": -122.1212121,
"spotterId": "SPOT-0222",
"waves": {
"significantWaveHeight": 1.91,
"peakPeriod": 10.24,
"meanPeriod": 7.72,
"peakDirection": 302.735,
"peakDirectionalSpread": 55.142,
"meanDirection": 279.846,
"meanDirectionalSpread": 70.635
},
"frequencyData": {
"frequency": [0.02930,0.03906,0.04883,...],
"df": [0.00977, 0.00977, 0.00977,...],
"a1": [-0.097752, -0.095797, -0.054741,...],
"b1": [-0.054741, 0.021505, 0.073314,...],
"a2": [0.120235, 0.115347, -0.018573,...],
"b2": [0.414467, 0.180841, 0.184751,...],
"varianceDensity": [0.7111054247697032, 0.6186233367451381, 0.6411207778915046,...],
"direction": [335.6588548979852, 338.1985905136482, 269.8174396209903,...],
"directionalSpread": [79.181787169671, 74.12281945451112, 67.45630665882223,...]
},
"wind": {
"speed": 1,
"direction": 2,
"seasurfaceId": 1
},
"surfaceTemperature": {
"degrees": 15
},
"partitionData": {
"partitions": [
{
"startFrequency": 0.025,
"endFrequency": 0.1953125,
"significantWaveHeight": 36.95,
"meanPeriod": 30.24,
"meanDirection": 185.994,
"meanDirectionalSpread": 15.328
},
{
"startFrequency": 0.1953125,
"endFrequency": 0.8,
"significantWaveHeight": 34.55,
"meanPeriod": 25.58,
"meanDirection": 200.062,
"meanDirectionalSpread": 37.692
}
]
},
"smartMooringData": [
{
"sensorPosition": 1,
"degrees": 10.2
},
{
"sensorPosition": 2,
"degrees": 10.16
}
],
"sensorData": [
{
"sensorPosition": 1,
"units": "°C",
"value": 18.060000000000002,
"unit_type": "temperature",
"data_type_name": "sofar_temperature_12bits"
},
{
"sensorPosition": 2,
"units": "μbar",
"value": 1020490,
"unit_type": "pressure",
"data_type_name": "rbrcoda3_meanpressure_21bits"
},
{
"sensorPosition": 2,
"units": "°C",
"value": 18.060000000000002,
"unit_type": "temperature",
"data_type_name": "rbrcoda3_meantemperature_20bits"
},
{
"sensorPosition": 2,
"units": "μbar",
"value": 90,
"unit_type": "pressure",
"data_type_name": "rbrcoda3_stdevpressure_15bits"
}
]
},
{
"timestamp": "2021-01-01T00:01:00Z",
"latitude": 38.777777,
"longitude": -123.1212121,
"spotterId": "SPOT-0223",
...
},
...
],
"metadata": {
"page": {
"nextPage": "https://api.sofarocean.com/api/search?shape=envelope&startDate=2021-01-01T00:00:00.000Z&endDate=2021-02-01T00:00:00.000Z&shapeParams=37,-122,39,-124",
"hasMoreData": true
}
}
}
Last updated
Was this helpful?