Navigator’s Routing API Documentation

Overview

The Maritime Route API provides a robust solution for maritime journey planning, offering flexible route generation for applications such as logistics management, maritime gaming simulations, and virtual nautical exploration. With varying levels of detail, the API delivers routes tailored to application requirements, from a broad overview to precise waypoints, along with total distance.

Base URL

https://api.kilomoana.com/api/v1/route

Endpoints

Find Route (Not Detailed)

• GET /find/notdetailed
• Description: Retrieves a route with a basic overview of waypoints.
• Query Parameters:
  • startLat (double): Latitude of the starting point.
  • startLon (double): Longitude of the starting point.
  • endLat (double): Latitude of the ending point.
  • endLon (double): Longitude of the ending point.
• Response: CoordinatesResponse JSON object.

Find Route (Low Detailed)

• GET /find/lowdetailed
• Description: Retrieves a route with a low level of waypoint detail.
• Query Parameters: Same as above.
• Response: CoordinatesResponse JSON object.

Find Route (Mid Detailed)

• GET /find/middetailed
• Description: Retrieves a route with a medium level of waypoint detail.
• Query Parameters: Same as above.
• Response: CoordinatesResponse JSON object.

Find Route (Very Detailed)

• GET /find/verydetailed
• Description: Retrieves a route with a high level of waypoint detail, but not the highest.
• Query Parameters: Same as above.
• Response: CoordinatesResponse JSON object.

Find Route (High Detailed)

• GET /find/highdetailed
• Description: Retrieves a route with the highest level of waypoint detail.
• Query Parameters: Same as above.
• Response: CoordinatesResponse JSON object.

Response Format

{
    "coordinates": [
        {
            "lat": 54.410807,
            "lng": 10.211408
        },
        // ...additional coordinates...
    ],
    "distance": 29.707944687843842
}

• coordinates (array): An array of coordinate objects with lat (latitude) and lng (longitude) keys.
• distance (double): The total distance of the route in nautical miles.

Usage Notes

• Routes are calculated for planning and estimation purposes only and should not be used for actual navigation.
• The detail level of the route can be adjusted to optimize data usage and application performance.