Historical Data
The /wave-data url communicates data collected from a deployed Spotter's wave sensors within a given date-time window.
Note: For additional details, please expand the section by clicking '>'
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
Last updated