This endpoints returns the route between a source location and a target location on sea, along with the route distance (in meters), duration (in milliseconds) and details about the zones it goes through. We return the shortest route sailed considering traffic separation schemes and port entries.
Origin, destination and intermediary points
Coordinate pairs are used for positions. They are formatted as longitude,latitude, and separated by semicolons ;. You can add up to 20 coordinate pairs, including intermediary points on a route (up to 18), or request several legs of a trip in one go by listing more than two coordinate pairs. For instance: -1.26617431640625,50.79551936692376;8.8330078125,53.88491634606499;-3.2409667968749996,53.50111704294316.
Vessel specific routes
You can get vessel specific routes by specifying the IMO number of a vessel. The returned route will be compatible with the vessel dimensions (width (in m), length (in m), maximum draft (in m)). If the IMO is not given, We choose a small vessel in order not to block any route.
You can also specify the current draft (in m) of the vessel using the parameter vesselDraft, with or without giving an IMO. If both IMO and vessel draft are given, the given draft (in m) is used and the other dimensions (width, length) are retrieved from the IMO number.
The response contains static information about the vessel used (width (in m), length (in m), maximum draft (in m)).
Continuous coordinates
Depending on the boolean parameter continuousCoordinates, the longitudes of the points of the route returned can be between -180° and 180° (false) or continuous (ie greater than 180° or lower than -180° after crossing the antimeridian).
The default behavior is to return continuous coordinates (the parameter is set to true as default). However, we encourage the use of normalized longitudes between -180° and 180° setting the parameter to true when requesting a route.
Routing parameters
Departure time (Unix time in ms) and speed can be specified in order to get an accurate ETA. The speed can be given in knots using the parameter speedInKts or in km/h using the parameter speed. The ETA (Unix time in ms) and duration (in ms) take into account the maximum authorized speed in specific areas such as canals. If the vessel speed is superior to the authorized speed of a crossed area, we assume the vessel will sail at maximum authorized speed in the area and at the given vessel speed outside the area.
Avoid zones
ECA zones can be avoided by using the parameter avoidSeca. In that case, the distance travelled in the ECA zone is minimized.
The HRA (high risk area) zone can be avoided using parameter avoidHRA. If no points from the query are in the HRA zones, the zone will be totally avoided, if at least one point is in the HRA zone, the route will go through it but minimize the distance navigated in it. The distance in HRA is available in the response in the field hraIntersection.
Ice areas and block areas
By default, the seas that are difficult to sail due to the presence of ice are not allowed (for example the Bering Sea, the Northern Sea Route, etc). You can allow the route to go through these zones by using the allowIceAreas parameter.
It is possible to block some areas by using the parameter blockAreas which takes a list of ids (Panama Canal : 11112 , Suez Canal : 11117). In that case, the route won't cross the areas blocked.
Note that all rivers are available on this endpoint using appropriate vessel draft (in m).
Waypoints returned
This endpoint additionally returns a list of waypoints of interest in the waypoints fields of the properties of each leg. The waypoints can be of different types :
VOYAGEfor voyage scale events such as departure and arrival with class eitherENTRYorEXIT;ROUTINGfor special zones with class eitherENTRYorEXIT;SECAfor ECA zones with class eitherENTRYorEXIT;SPEEDfor points where speed must be adjusted with classINCREASE,DECREASEorTARGET(only used to know the speed at departure when it must be different than the given speed).