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
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "http://demo.waterlinked.com/api/" \
-H "Accept: application/json"const response = await fetch("http://demo.waterlinked.com/api/", {
method: "GET",
headers: {
"Accept": "application/json",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"http://demo.waterlinked.com/api/",
headers={
"Accept": "application/json",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /api/ | ApiVersion about |
| GET | /api/v1/about | Get about |
| POST | /api/v1/about/factoryreset | FactoryReset about |
| GET | /api/v1/about/led | LED about |
| GET | /api/v1/about/status | Status about |
| GET | /api/v1/about/temperature | Temperature about |
| GET | /api/v1/config/antenna | GetAntennaConfig config |
| PUT | /api/v1/config/antenna | ModifyAntennaConfig config |
| GET | /api/v1/config/generic | Get config |
| PUT | /api/v1/config/generic | Modify config |
| GET | /api/v1/config/ip | GetIP config |
| PUT | /api/v1/config/ip | ModifyIP 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/wifi | GetWIFI config |
| PUT | /api/v1/config/wifi | ModifyWIFI config |
| PUT | /api/v1/external/depth | SetDepth external |
| GET | /api/v1/external/imu | GetVehicleIMU external |
| PUT | /api/v1/external/imu | SetVehicleIMU external |
| PUT | /api/v1/external/master | SetMaster external |
| GET | /api/v1/external/orientation | GetOrientation external |
| PUT | /api/v1/external/orientation | SetOrientation external |
| GET | /api/v1/imu/calibrate | Get imu |
| POST | /api/v1/imu/calibrate | Calibrate imu |
| POST | /api/v1/imu/resetgyros | ResetGyro imu |
| POST | /api/v1/imu/setnorth | SetNorth 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/filtered | AcousticFiltered position |
| GET | /api/v1/position/acoustic/raw | AcousticRaw position |
| GET | /api/v1/position/global | Get position |
| GET | /api/v1/position/master | GetMaster 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.
Similar geocoding APIs
Compare alternatives →Bing Maps
GeocodingCreate/customize digital maps based on Bing Maps data
ip-api
GeocodingFind location with IP address or domain
OpenStreetMap
GeocodingNavigation, geolocation and geographical data
GeographQL
GeocodingA Country, State, and City GraphQL API
IP Address Details
GeocodingFind geolocation with ip address
ipapi.co
GeocodingFind IP address location information
Listed from APIs.guru (CC0).