Historical Data
The /wave-data url communicates data collected from a deployed Spotter's wave sensors within a given date-time window.
Fetch Historical Data
GET
https://api.sofarocean.com/api/wave-data?spotterId=:spotterId
Returns waves and sensor data for the corresponding spotterId
* If you're a realtime Spotter Data customer and do not own your own Spotters, note that results for the wave-data endpoint will be fixed to a 30 day real-time window.
* frequencyData
is only available for samples collected from Spotters in Waves: Spectrum mode or HDR mode.
* partitionData
is only available for samples collected from Spotters in Waves: Partition mode or HDR mode.
* barometerData
is only available for samples collected from barometer-equipped Spotters
Query Parameters
Name | Type | Description |
---|---|---|
spotterId | string | SpotterId of the device to retrieve data for. |
limit | number | default: |
startDate | string | default: |
endDate | string | default: |
includeWaves | boolean | default: |
includeWindData | boolean | default: |
includeSurfaceTempData | boolean | default: |
includeTrack | boolean | default: |
includeFrequencyData | boolean | default: |
includeDirectionalMoments | boolean | default: |
includePartitionData | boolean | default: |
includeBarometerData | boolean | default: |
processingSources | string | default: Select from which data processing source to receive data: [ * HDR processing source only applicable to cellular-equipped Spotters running in HDR mode |
Example Request
Response Description
The /wave-data
response format includes general device information, waves data, and location track (depending on device mode).
For more information on data collected by Spotter, see the product documentation: https://www.sofarocean.com/posts/spotter-product-documentation.
Response Parameter Units
Wave Height: meters Periods: seconds Directions: degrees Location: decimal degrees Variance Density: m^2/Hz Directional Moments: unitless Wind Speed: m/s Timestamp: ISO8601-formatted timestamp string, indicating the end of a wave statistics collection period
Example Response
Last updated