Vessel Route to Port
A newer version of this endpoint is available here: https://developers.kpler.com/spec/c78f79cf-4169-4a59-987d-e5970ea170f9 Receive a list of available routes and distances from a vessel to a port. Notes
- The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.
path Parameters
| api_key required | string API key: 40-character hexadecimal number |
query Parameters
| mmsi required | integer The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead use imo or shipid |
| imo | integer The International Maritime Organization (IMO) number of the vessel you wish to track |
| shipid | integer A uniquely assigned ID by MarineTraffic for the subject vessel |
| port_target_id required | integer The MarineTraffic ID of the port you wish to put as target port (found on the URL of the respective Port page) or port UN/LOCODE |
| includealternatives | integer Use 1 to search for all available routes regarding the specific journey or 0 to not include alternative routes |
| includeinland | integer Use 1 in order to receive routes which include inland waterways or 0 to not include alternative routes |
| msgtype | string Default: "simple" Resolution of the response. Available values:
|
| protocol | string Default: "xml" Response type. Use one of the following:
|
Responses
Response samples
- 200
- 400
- 429
[- {
- "DISTANCE": "2938",
- "PANAMA": "0",
- "SUEZ": "0"
}
]Distance to Port
A newer version of this endpoint is available here: https://developers.kpler.com/spec/c78f79cf-4169-4a59-987d-e5970ea170f9 Receive a list of available routes and distances from point or port to a specific port. Notes
- The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.
path Parameters
| api_key required | string API key: 40-character hexadecimal number |
query Parameters
| port_start_id required | integer The MarineTraffic ID of the port you wish to put as starting point (found on the URL of the respective Port page) or port UN/LOCODE |
| LAT | number The latitude of the starting point It can be used together with LON instead of port_start_id |
| LON | integer The longitude of the starting point It can be used together with LAT instead of port_start_id |
| port_target_id required | integer The MarineTraffic ID of the port you wish to put as target port (found on the URL of the respective Port page) or port UN/LOCODE |
| includealternatives | integer Use 1 to search for all available routes regarding the specific journey or 0 to not include alternative routes |
| includeinland | integer Use 1 in order to receive routes which include inland waterways or 0 to not include alternative routes |
| msgtype | string Default: "simple" Resolution of the response. Available values:
|
| protocol | string Default: "xml" Response type. Use one of the following:
|
Responses
Response samples
- 200
- 400
- 429
[- {
- "DISTANCE": "2938",
- "PANAMA": "0",
- "SUEZ": "0"
}
]