Get the geometry of routes

Deprecated notice : this endpoint will be removed in future versions. You should use GET /v3/routes and GET /v3/route/{id}/geometry endpoints.

Generate the geometry of one or multiple routes, in GeoJSON format.
Unlike /v3/routes/{id}/geometry, this endpoint does not require a route snapshot id, but returns geometries based on the route parameters provided in the request body.

Notes and considerations

  • Route types:
    • shortest → shortest feasible path, considering traffic separation schemes and port entries.
    • historical → reconstructs past voyages around the given departureDate using AIS data.
    • proforma → based on carrier service plans.
    • schedule → based on upcoming carrier vessel departures.
  • The response follows the GeoJSON standard.
  • Use this endpoint when you want the geometry directly from input parameters, without creating a snapshot id.

Support endpoints and resources

  • The id returned in the response of /v3/routeGeometries is also a valid route snapshot id and can be reused with sub-resources such as fuel, emission, or geometry.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

route search details

string
enum
required

Type of route to compute.

Allowed:
assets
array
assets
waypoints
array of objects
required

list of waypoints. Must contain at least origin and destination of the route.

waypoints*
carrier
object
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json