This API returns the estimated voyage path and PTA (Predicted Time of Arrival) from the vessel’s current location to the specified port, based on the inputted IMO number and portId.
Authentication
The Past Track API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the pop-up window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Authentication
Request URL
Request URL : [POST] https://insight.seavantage.com/api/route/ship-to-port
Execution Steps
1.
2.
Navigate to the /route/ship-to-port endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values based on the following Parameters:
•
imoNo: The IMO number of the vessel for which the predicted route will be generated.
•
portId: A unique port identifier (Port ID) issued by SeaVantage.
•
Request body: If a routing option is provided, the route will be predicted based on that option. If not, the default setting will be used for route prediction.
5.
Click the [Execute] button.
6.
View results in the response section.
Request body Example
{
"routeMethod": "frequency",
"maxSpeed": 17,
"options": {
"eca": 2,
"hra": 2,
"jwc": 1,
"cyclone": 2,
"avoid": [],
"frequencyPercentage": 45,
"speedType": "upper10"
}
}
JavaScript
복사
Field Descriptions
•
routeMethod: Routing preference
◦
distance: Prioritize shortest distance
◦
time: Prioritize shortest travel time
◦
frequency: Prioritize most frequently traveled route
•
maxSpeed: Maximum vessel speed (in knots)
•
options.eca: Emission Control Area (ECA) routing option
1.
Take the shortest route through the ECA
2.
Ignore ECA and proceed
3.
Avoid the ECA entirely
•
options.hra: High-Risk Area (HRA) routing option
1.
Take the shortest route through the HRA
2.
Ignore the HRA and proceed
3.
Avoid the HRA entirely
•
options.jwc: Joint War Committee (JWC) routing option
1.
Take the shortest route through the JWC
2.
Ignore the JWC and proceed
3.
Avoid the JWC entirely
•
options.cyclone: Cyclone zone routing option
1.
Take the shortest route through the area
2.
Ignore the cyclone area and proceed
3.
Avoid the cyclone area entirely
•
options.avoid: Canal(s) to avoid during route planning
◦
88f3f52e-2b8a-11e9-8abd-54802853d888: Suez Canal
◦
3f298f0e-2b89-11e9-8abd-54802853d888: Panama Canal
◦
7addce3a-5927-11ea-87d0-54802853d888: Kiel Canal
•
options.frequencyPercentage: Percentage weight applied when using frequency-based routing
•
options.speedType: Speed setting for route estimation
◦
top: Maximum speed
◦
average: Average speed
◦
upper10: Top 10% speed
◦
lower10: Bottom 10% speed
Response Information
Sample Response Format
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-04T05:47:30.441096649",
"response": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
[
126.491341,
33.499621
],
[
126.491341,
33.499621
]
],
"type": "LineString",
"emptyCoordinate": false
},
"properties": {
"distanceHra": 100,
"atNoonPoints": [
{
"dateTime": "2025-03-01T23:59:59Z",
"longitude": 80,
"latitude": 80
}
],
"startDateTime": "2025-03-01T23:59:59Z",
"hours": 10,
"portStayHours": 2,
"arrivalName": "arrival name",
"startNo": 1,
"distance": 100,
"startName": "start name",
"maxSpeed": 20,
"seaStayHours": 2,
"arrivalDateTime": "2025-03-01T23:59:59Z",
"courseHours": 10,
"distanceEca": 100,
"planPoints": [
{
"speed": 0,
"dateTime": "2025-03-01T23:59:59Z",
"longitude": 80,
"latitude": 80,
"eca": false
}
],
"distanceJwc": 100,
"arrivalNo": 1
}
}
]
}
}
JSON
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 200 | Response status code (used in the same way as standard HTTP status codes).
(See the list of codes below for reference.) |
message | success | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-14T01:09:00.834665213 | Time of response creation (UTC) |
response | Object | Returns an object if a predicted route exists. |
Response Codes
Code | Description |
200 | Success |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |
Detailed Response Description
Depth 1 Field Description (geometry object)
Returns a GeoJSON object
Field | Example Value | Description | Data Type |
type | Feature | Type of line | varchar |
coordinates | [126.491341, 33.499621], [126.491341, 33.499621] | List of route coordinates | double precision |
emptyCoordinate | false | boolean |
Depth 2 Field Description (properties object)
Returns the properties of the GeoJSON object
Field | Example Value | Description | Data Type |
startDateTime | 2025-03-01T23:59:59Z | Departure time (last received vessel position timestamp) | timestamp |
hours | 10 | Total elapsed time | double precision |
portStayHours | 0.0 | Time spent at port | double precision |
arrivalName | dc822048-5534-11e9-a747-54802853d888 | Port ID of the arrival port | varchar |
startNo | 1 | Departure waypoint number | integer |
distance | 100 | Distance | double precision |
startName | 1234567 | IMO number of the departure vessel | varchar |
maxSpeed | 17 | Target speed (knots) | double precision |
seaStayHours | 0.0 | Time spent at sea | double precision |
arrivalDateTime | 2025-05-01T23:59:59Z | PTA: Predicted Time of Arrival | timestamp |
courseHours | 10 | Voyage time from departure to arrival | double precision |
distanceEca | 0.0 | Distance through Emission Control Areas (ECA) | double precision |
distanceHra | 0.0 | Distance through High-Risk Areas (HRA) | double precision |
distanceJwc | 0.0 | Distance through War Risk Areas (JWC) | double precision |
arrivalNo | 1 | Arrival waypoint number | integer |
Depth 3 Field Description (planPoints object)
Returns the average speed for each segment of the predicted route, along with whether the vessel is located within ECA, HRA, or JWC zones
Field | Example Value | Description | Data Type |
speed | 0 | Speed (knots) | integer |
dateTime | 2025-03-01T23:59:59Z | Estimated time | timestamp |
longitude | 80 | Longitude | double precision |
latitude | 80 | Latitude | double precision |
eca | false | Within ECA zone | boolean |
hra | false | Within HRA zone | boolean |
jwc | false | Within JWC zone | boolean |
Depth 4 Field Description (atNoonPoints object)
Returns the vessel's position and PTA based on the midday point of the predicted route
Field | Example Value | Description | Data Type |
dateTime | 2025-03-01T12:00:00Z | Midday time | timestamp |
longitude | 80 | Midday longitude | double precision |
latitude | 80 | Midday latitude | double precision |