Devices

The /devices url returns a list of your Spotters, including the Spotter ID and name for each.

Note: For additional details, please expand the section by clicking '>'

Available Devices

GET https://api.sofarocean.com/api/devices

Retrieve a list of Spotters you have API access to, including Spotter ID and nickname.

Query Parameters

NameTypeDescription

excludeSharedDevices

boolean

default: false Set true to only return devices you own.

{
  "message": "2 devices",
  "data": {
    "devices": [
      {
        "spotterId": "SPOT-0017",
        "name": "Mavericks 1"
      },
      {
        "spotterId": "SPOT-0018",
        "name": "Golden Gate"
      }
    ]
  }
}

Example Request

curl "https://api.sofarocean.com/api/devices" -H 'token: YOUR_API_TOKEN'

Last updated