This API retrieves the port call history of a vessel within a specified time frame, based on the ship's UUID (shipId), start date, and end date. It is updated on average every 15 minutes based on AIS data.
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.
Request Information
Request URL
Request URL : [GET] https://insight.seavantage.com/api/port-call/{shipId}
Execution Steps
1.
2.
Navigate to the /port-call/{shipId} endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values based on the following Parameters:
•
•
from: Start date of the vessel's movement path, provided in UTC format.
ex) 2025-01-01T00:00:00Z
•
to: End date of the vessel's movement path, provided in UTC format.
ex) 2025-01-01T23:59:59Z
5.
Click the [Execute] button.
6.
View results in the response section.
Response Information
Sample Response Format
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"departurePort": {
"portId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 35.1796,
"longitude": 129.0756,
"timezone": "+09:00",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}"
},
"arrivalPort": {
"portId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 35.1796,
"longitude": 129.0756,
"timezone": "+09:00",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}"
},
"atd": "2025-08-04T05:31:38.160Z",
"ata": "2025-08-04T05:31:38.160Z",
"atb": "2025-08-04T05:31:38.160Z",
"atSeaHour": 10.5,
"atSeaDistance": 100,
"inPortHour": 5,
"inPortDistance": 50,
"ecaDistance": 20
}
]
}
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 | Array or Empty Array | An array is returned if the vessel exists; otherwise, an empty array is returned. |
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 (response object)
Field | Example Value | Description | Data Type |
atd | 2025-05-13T09:32:29.460Z | Actual Time of Departure | timestamp |
ata | 2025-05-13T09:32:29.460Z | Actual Time of Arrival | timestamp |
atb | 2025-05-13T09:32:29.460Z | Actual Time of Berthing | timestamp |
atSeaHour | 177.75 | Total voyage time between ports (sea route only) | double precision |
atSeaDistance | 870.385 | Total distance traveled between ports (sea route only) | double precision |
inPortHour | 78.75 | Time spent moving within port boundaries | double precision |
inPortDistance | 7.0155673 | Distance traveled within port boundaries | double precision |
ecaDistance | 0 | Distance traveled within ECA (Emission Control Area) zones | double precision |
departurePort | [object Object] | Depth 2 → See departurePort and arrivalPort objects | |
arrivalPort | [object Object] | Depth 2 → See departurePort and arrivalPort objects |
Depth 2 Field Description (departurePort, arrivalPort object)
Field | Example Value | Description | Data Type |
portId | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Internal port identifier used by SeaVantage | varchar(36) - UUID |
portName | Lake Charles | Port name | varchar(255) |
unlocode | USLCH | Port UN/LOCODE | varchar(36) |
nationCode | US | Flag State (Country of Registration) | varchar(36) |
latitude | 30.16705757 | Latitude | double precision |
longitude | -93.28987508 | Longitude | double precision |
timezone | -06:00 | Local timezone of the port | varchar(36) |
geoData | {\"type\":\"Polygon\",\"coordinates\":[[[-93.245241209,30.235700469],[-93.239001696,30.219920273],[-93.274622474,30.101477518],[-93.32514921,30.101209342],[-93.337327325,30.143453744],[-93.337338055,30.171193622],[-93.283388298,30.2346084],[-93.245241209,30.235700469]]]} | Geospatial boundary data defining the port area | text |