Search (Beta)
The /search url communicates data collected from all accessible Spotter's wave sensors within a specified geospatial area and date-time window.
Note: For additional details, please expand the section by clicking '>'
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
Name | Type | Description |
---|---|---|
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
|
endDate | string | Timestamp indicating the start date for data inclusion. Must be a ISO 8601 formatted string
|
pageSize | integer | The desired number of samples returned at once
|
radius | number | Radius (in meters) of geospatial area to query.
Only used if |
Last updated