Skip to content

The Water Linked Underwater GPS API API

by waterlinked.com

No authHTTPSGeocoding
Open documentation ↗

Overview

API for the Water Linked Underwater GPS. For more details: http://www.waterlinked.com Recommended approach for connecting to a Underwater GPS via the API is: - If "GET /api/" times out, the Underwater GPS is not running (on this IP address) - If "GET /api/" responds with 200 OK check that the api version returrned (eg "v1") is supported by the client (eg: also supports "v1"). - If the api version returned does not match what the client supports: give an error to the user and recommend upgrading. (Eg: response is "v2" while client only supports "v1") - If "GET /api/" responds with 301 Moved permanently. "GET /api/v1/version" to check if the kit has a version earlier than 1.5. - "GET /api/v1/version" will always respond with 200 OK on Underwater GPS earlier than 1.5 release. Configuration API is is not considered stable and will potentially be changed

The Water Linked Underwater GPS API is a geocoding API from waterlinked.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 38 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Geocoding
Base URL
http://demo.waterlinked.com
Version
1.0.0
Endpoints
38
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "http://demo.waterlinked.com/api/" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("http://demo.waterlinked.com/api/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "http://demo.waterlinked.com/api/",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/api/ApiVersion about
GET/api/v1/aboutGet about
POST/api/v1/about/factoryresetFactoryReset about
GET/api/v1/about/ledLED about
GET/api/v1/about/statusStatus about
GET/api/v1/about/temperatureTemperature about
GET/api/v1/config/antennaGetAntennaConfig config
PUT/api/v1/config/antennaModifyAntennaConfig config
GET/api/v1/config/genericGet config
PUT/api/v1/config/genericModify config
GET/api/v1/config/ipGetIP config
PUT/api/v1/config/ipModifyIP config
GET/api/v1/config/receivers/ListReceiver config
GET/api/v1/config/receivers/{ID}ShowReceiver config
PUT/api/v1/config/receivers/{ID}ModifyReceiver config
GET/api/v1/config/wifiGetWIFI config
PUT/api/v1/config/wifiModifyWIFI config
PUT/api/v1/external/depthSetDepth external
GET/api/v1/external/imuGetVehicleIMU external
PUT/api/v1/external/imuSetVehicleIMU external
PUT/api/v1/external/masterSetMaster external
GET/api/v1/external/orientationGetOrientation external
PUT/api/v1/external/orientationSetOrientation external
GET/api/v1/imu/calibrateGet imu
POST/api/v1/imu/calibrateCalibrate imu
POST/api/v1/imu/resetgyrosResetGyro imu
POST/api/v1/imu/setnorthSetNorth imu
GET/api/v1/poi/List poi
POST/api/v1/poi/Create poi
GET/api/v1/poi/{ID}Show poi
PATCH/api/v1/poi/{ID}Update poi
DELETE/api/v1/poi/{ID}Delete poi
GET/api/v1/position/acoustic/filteredAcousticFiltered position
GET/api/v1/position/acoustic/rawAcousticRaw position
GET/api/v1/position/globalGet position
GET/api/v1/position/masterGetMaster position
GET/api/v1/status_report/Get status_report
GET/api/v1/warnings/Get warnings

Questions

Does the The Water Linked Underwater GPS API API need an API key?

No. The The Water Linked Underwater GPS API API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the The Water Linked Underwater GPS API API support HTTPS?

Yes, the The Water Linked Underwater GPS API API is served over HTTPS.

How many endpoints does the The Water Linked Underwater GPS API API have?

Its OpenAPI description lists 38 endpoints in version 1.0.0. All of them are shown on this page.

What are alternatives to the The Water Linked Underwater GPS API API?

Other Geocoding APIs include Bing Maps, ip-api, OpenStreetMap, GeographQL, IP Address Details.

Compare alternatives →

Listed from APIs.guru (CC0).