Get distance between two points using the given modality.

GET /api/distance

Query parameters

  • origin string Required

    Origin of voyage. Can be a locode, a terminal UUID, or a lat,long

  • destination string Required

    Destination of voyage. Can be a locode, a terminal UUID, or a lat,long

  • modality string Required

    Modality of voyage. Can be one of [DEEPSEA, BARGE, RAIL, TRUCK]

  • vesselInfo string

    Optional vessel information. Can be dimensions (length, width, draught) in cm or ship IMO/MMSI. Example: 100,50,25 or IMO1234567 or MMSI027811100

Responses

  • 200 application/json

    Calculated the distance in meters

    Hide response attribute Show response attribute object
  • 204

    The distance couldn't be calculated because a route could not be found

  • 400

    Bad request, query parameters were wrong

  • 500

    Something went wrong on our side.

GET /api/distance 
curl \
 --request GET 'https://connect.routescanner.com/route-information/api/distance?origin=string&destination=string&modality=string'
Response examples (200) 
{
  "distance": 42
}