This API retrieves the vessel’s operational schedule for the upcoming 8 weeks based on the entered IMO number, starting from the current date.
Authentication
The Operational Vessel Schedules 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/voyage/schedule
Execution Steps
1.
In the Swagger Documentation, select Operational Vessel Schedules from the Select a definition menu at the top right.
2.
Navigate to the /voyage/schedule endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
•
imoNo: The ship’s IMO number
ex) 9619907
5.
Click [Execute].
6.
View results in the response section.
Response Information
The response is returned in the following format, regardless of whether the request is successful or failed.
Sample Response Format
{
"code": 200,
"message": "success",
"error": false,
"timestamp": "2025-08-22T02:36:05.554967279",
"response": {
"ship": {
"shipId": "b7ac555e-8b3a-11e9-b34d-54802853d888",
"shipName": "MAERSK MC-KINNEY MOLLER",
"imoNo": "9619907",
"mmsi": "219018271",
"callSign": "OWIZ2"
},
"calls": [
{
"serviceName": "AE1",
"carrierCode": "MAEU",
"voyageNumber": "530W|536E",
"portId": "89d1b0d6-d5df-11e8-890a-7085c2711781",
"portName": "ROTTERDAM",
"unlocode": "NLRTM",
"nationCode": "NL",
"latitude": 51.92649024,
"longitude": 4.22608932,
"timezone": "+01:00",
"terminalId": "291609a9-a994-4b90-b48d-0b09f0d6d3ad",
"terminalName": "APM 2 TERMINAL MAASVLAKTE II",
"eta": "2025-09-01T12:00:00Z",
"etb": null,
"etd": "2025-09-03T04:00:00Z",
"ata": null,
"atb": null,
"atd": null
}
]
}
}
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 or null | Returns an Object if data exists, or null if no data is found. |
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 (ship object)
Field | Example Value | Description | Data Type |
shipId | b7ac555e-8b3a-11e9-b34d-54802853d888 | SeaVantage unique vessel ID | varchar(36) - UUID |
shipName | MAERSK MC-KINNEY MOLLER | Vessel name | varchar(100) |
imoNo | 9619907 | Vessel IMO registration number | varchar(10) |
mmsi | 219018271 | Vessel unique identifier | varchar(10) |
callSign | OWIZ2 | Call sign | varchar(7) |
Depth 2 Field Description (calls object)
Field | Example Value | Description | Data Type |
serviceName | AE1 | Service route | varchar |
carrierCode | MAEU | SCAC 4-digit carrier code | varchar(15) |
voyageNumber | 530W|536E | Voyage number | varchar(50) |
portId | 89d1b0d6-d5df-11e8-890a-7085c2711781 | Internal port identifier | varchar(36) - UUID |
portName | ROTTERDAM | Port name | varchar(100) |
unlocode | NLRTM | Port UNLOCODE | varchar(36) |
nationCode | NL | Nation code | varchar(36) |
latitude | 51.92649024 | Latitude | double precision |
longitude | 4.22608932 | Longitude | double precision |
timezone | +01:00 | Port timezone | varchar(36) |
terminalId | 291609a9-a994-4b90-b48d-0b09f0d6d3ad | Internal terminal identifier provided by SeaVantage | varchar(36) - UUID |
terminalName | APM 2 TERMINAL MAASVLAKTE II | Terminal name | varchar(100) |
eta | 2025-09-01T12:00:00Z | Carrier-collected Estimated Time of Arrival (ETA) | timestamp |
etb | 2025-09-01T12:00:00Z | Carrier-collected Estimated Time of Berthing (ETB) | timestamp |
etd | 2025-09-01T12:00:00Z | Carrier-collected Estimated Time of Departure (ETD) | timestamp |
ata | 2025-09-01T12:00:00Z | SeaVantage port call data – Actual Time of Arrival (ATA) | timestamp |
atb | 2025-09-01T12:00:00Z | SeaVantage port call data – Actual Time of Berthing (ATB) | timestamp |
atd | 2025-09-01T12:00:00Z | SeaVantage port call data – Actual Time of Departure (ATD) | timestamp |