Credit methods

Distance

Calculates the shortest sea route between two points and returns it as a GeoJSON Feature with a LineString geometry. All gateways (canals, straits, passages) are closed by default; open them with gateways. XML is not supported.

get/distance

Request

  • Base URL
    https://api.vesselfinder.com
  • Auth
    API key in query parameter userkey

Query parameters

errormode409

Set to 409 to receive errors as HTTP 409 with a plain-text body instead of HTTP 200 with an error object.

fromstring required

Start point as lon,lat (WGS84).

tostring required

End point as lon,lat (WGS84).

gatewaysstring

Comma-separated gateways to open for crossing.

ECA'allow' | 'deny' | 'minimize'

How the route treats Emission Control Areas. With deny, if no route avoids the ECA zones, the API returns the error path not found.

EPSG38570 | 1

1 returns coordinates in EPSG:3857 (Web Mercator) instead of WGS84.

Response

Route as a GeoJSON Feature.

OR

Example response

{
  "error": "ERROR DESCRIPTION"
}

Changes

No recorded changes to this operation across all 1 revision of this API.