Route API

Route API는 해양으로 이동 할 수 있는 두 지점 사이의 가장 짧은 경로를 이루는 웨이포인트 목록과 총 이동 마일을 제공합니다.

Data Name

Route API

BASE URL PATH

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

DATA COVERAGE

Global

Routing

1. Routing

USE OUR WIZARD TO TRY OUT THIS ENDPOINT ➜

1.1 Request Parameter

curl --request GET \
     --url 'https://api.vessellink.com/v1/route?fromLat=28.3&fromLong=140.3&toLat=12.2&toLong=-50.3&autoValidate=false&suez=true&panama=true&kiel=true&northeast=false&northwest=false&eca=ignore&hra=ignore&jwc=ignore' \
     --header 'Accept: application/json'

Parameter	Description	Type
`fromLat`	Latitude of the departure	(float) ISO 6709 (decimal point)
`fromLong`	Longitude of the departure	(float) ISO 6709 (decimal point)
`toLat`	Latitude of the destination	(float) ISO 6709 (decimal point)
`toLong`	Longitude of the destination	(float) ISO 6709 (decimal point)
`autoValidate`	If set to true, a validation for both start and endpoint will be performed and the validated coordinates will be used as input for the route calculation	true or false
`suez`	Allow passage of the Suez channel. Possible values: true and false	true or false
`panama`	Allow passage of the Panama channel. Possible values: true and false	true or false
`kiel`	Allow passage of the Kiel channel. Possible values: true and false	true or false
`northeast`	Allow passage of the Northeast Passage. Possible values: true and false	true or false
`northwest`	Allow passage of the Northwest Passage. Possible values: true and false	true or false
`eca`	Indication of how to treat ECA areas. Possible values: 'ignore' and 'minimize'	true or false
`hra`	Indication of how to treat HRA area(s). Possible values: 'ignore' and 'minimize'	true or false
`jwc`	Indication of how to treat JWC area(s). Possible values: 'ignore' and 'minimize'	true or false

1.3 API Response

The response are GeoJSON structured like above

{
    "meta": {
        "code": 200,
        "fromLat": 32.6733,
        "fromLong": 33.1743,
        "toLat": 35.9252,
        "toLong": 24.8067
    },

    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "properties": {
            "totalLDistance": 558.49614719928,
            "ecaDistance": 0,
            "hraDistance": 0,
            "canalsCrossed": [
                "suez-canal"
            ]
        },
        "geometry": {
            "type": "LineString",
            "coordinates": [
                [32.67333984375, 33.174341551002],
                [32.3423, 31.2228],
                [32.310393, 31.094417],
                [32.319995, 30.811504],
                [32.342453, 30.703486],
                [32.305385, 30.568682],
                [32.396751, 30.357018],
                [32.449684, 30.285923],
                [32.500598, 30.260175],
                [32.52428, 30.244705],
                [32.560229, 30.198274],
                [32.585092, 29.973555],
                [32.567552, 29.923606],
                [32.714583, 29.448333],
                [33.237083, 28.553278],
                [34.018333, 27.504556],
                [35.92529296875, 24.806681353852]
            ]
        }
    }]
}

Field	Description	Unit
`meta` - `code`	Response code	integer
`meta` - `fromLat`	Latitude of the departure	(float) ISO 6709 (decimal point)
`meta` - `fromLong`	Longitude of the departure	(float) ISO 6709 (decimal point)
`meta` - `toLat`	Latitude of the destination	(float) ISO 6709 (decimal point)
`meta` - `toLong`	Longitude of the destination	(float) ISO 6709 (decimal point)
`features` - `totalLDistance`	Total distance	(float) Nautical Miles
`features` - `ecaDistance`	Eca area distance	(float) Nautical Miles
`features` - `hraDistance`	Hra area distance	(float) Nautical Miles
`features` - `canalsCrossed`	Canals that are crossed, when traveling on the given route	(array string)
`geometry` - `coordinates`	list of route	(array object)