Docs

Navigator’s Routing API Documentation

Chart Your Maritime Path with Precision

Overview

Navigator’s Routing API is the quintessential tool for maritime route planning, delivering a versatile set of features perfect for integrating sophisticated route generation capabilities into your applications. Designed to cater to various sectors including logistics, gaming, and virtual exploration, our API empowers developers to chart courses with varying levels of detail to fit the needs of their projects.

Endpoints

Route Discovery (Not Detailed)

  • GET /find/notdetailed
  • Purpose: Obtain a simplified overview of the maritime route with basic waypoints.
  • Query Parameters:
  • startLat (double): Starting point latitude.
  • startLon (double): Starting point longitude.
  • endLat (double): Destination latitude.
  • endLon (double): Destination longitude.
  • Returns: CoordinatesResponse JSON object.

Route Discovery (Low Detailed)

  • GET /find/lowdetailed
  • Purpose: Get a route with a low density of waypoints for a clearer path.
  • Query Parameters: Same as above.
  • Returns: CoordinatesResponse JSON object.

Route Discovery (Mid Detailed)

  • GET /find/middetailed
  • Purpose: Retrieve a route with a moderate level of detail for waypoints.
  • Query Parameters: Same as above.
  • Returns: CoordinatesResponse JSON object.

Route Discovery (Very Detailed)

  • GET /find/verydetailed
  • Purpose: Acquire a highly detailed route short of the maximum detail, offering a comprehensive path.
  • Query Parameters: Same as above.
  • Returns: CoordinatesResponse JSON object.

Route Discovery (High Detailed)

  • GET /find/highdetailed
  • Purpose: Access the most intricate route details with the highest waypoint density.
  • Query Parameters: Same as above.
  • Returns: CoordinatesResponse JSON object.

Response Structure

{
    "coordinates": [
        {"lat": 54.410807, "lng": 10.211408},
        // ...more coordinates...
    ],
    "distance": 29.707944687843842
}
  • coordinates (array): An array comprising objects with lat (latitude) and lng (longitude).
  • distance (double): Total route distance measured in nautical miles.

Implementation Notes

  • Routes are generated for estimation and strategic planning; they are not intended for real-time navigation.
  • Choose the appropriate level of route detail to balance between data comprehensiveness and application efficiency.