The state of public APIs| Submit an API

|API RANK| by Escape.tech

Benchmark and ranking of 5138+ public APIs by Escape.tech

Back to the list Request ranking update

The Water Linked Underwater GPS API (ranked 1589 of 5138)

https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/The_Water_Linked_Underwater_GPS_API_a70fd167_072b_4aad_9806_0fc3a7b7769b_yaml.yaml

GENERAL INFORMATION

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

SECURITY 4/5

The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.

  • OWASP issues detected: API7:2023

PERFORMANCE 4/5

The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.

  • The median response time of the API is 82.1 ms .

Get p50 under 220 ms to get a 4/5 score.

RELIABILITY 5/5

The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.

  • Self compliance: response objects matched the declared response types.
  • Server errors: the server did not return any 5xx error.

DESIGN 2/5

The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.

  • Respects OpenAPI 2.0 schema specification.
  • Contains comments and summaries.
  • Contains examples.
  • Does not contain duplicated objects.

Popularity 0/5

The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!

Last scanned: 4/24/2023