This API returns a list of vessels that departed from the specified port. The query period is limited to within one year.
Authentication
The Port Insight 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-insight/ships/history
Execution Steps
1.
In the Swagger Documentation, select Port Insight from the Select a definition menu at the top right.
2.
Navigate to the /port-insight/ships/history endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
β’
portId: The unique Port ID issued by SeaVantage.
β’
departureDaysAgo: Specifies how many days prior to the API call date to retrieve vessels that have departed from the port.
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": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"portId": "123e4567-e89b-12d3-a456-123456789012",
"shipId": "123e4567-e89b-12d3-a456-123456789012",
"status": "ON_THE_WAY",
"departureAtd": "2025-01-01T00:00:00Z",
"pta": "2025-01-01T00:00:00Z",
"ptaUpdatedAt": "2025-01-01T00:00:00Z",
"ata": "2025-01-01T00:00:00Z",
"atb": "2025-01-01T00:00:00Z",
"atd": "2025-01-01T00:00:00Z",
"stopHour": 12.3456,
"draught": 12.3456,
"previousDraught": 12.3456,
"draughtUpdatedAt": "2025-01-01T00:00:00Z",
"predictDistance": 12.3456,
"ship": {
"shipId": "47941f60-13b8-4718-bead-aa7c3c61d530",
"imoNo": "1234567",
"mmsi": "123456789",
"callSign": "ABC1234",
"shipName": "Ship Name",
"shipType": "CONTAINER",
"shipTypeBySize": "CONTAINER01",
"nationCode": "KR",
"dwt": 20000,
"maxDraught": 15.5
},
"departurePort": {
"portId": "47941f60-13b8-4718-bead-aa7c3c61d530",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 35.1796,
"longitude": 129.0756,
"timezone": "+09:00"
},
"predictedTerminal": {
"terminalId": "47941f60-13b8-4718-bead-aa7c3c61d530",
"terminalName": "Terminal Name"
},
"arrivalTerminal": {
"terminalId": "47941f60-13b8-4718-bead-aa7c3c61d530",
"terminalName": "Terminal Name"
}
}
]
}
JavaScript
볡μ¬
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 | OK | 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 | null or Object | Returns null or object depending on the context |
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 |
portId | 123e4567-e89b-12d3-a456-123456789012 | Internal port identifier used by SeaVantage | varchar(36) - UUID |
shipId | 123e4567-e89b-12d3-a456-123456789012 | SeaVantage internal unique ship ID | varchar(36) - UUID |
status | ON_THE_WAY | Vessel status information | varchar(16) |
departureAtd | 2025-01-01T00:00:00Z | Departure time from previous port | timestamp |
pta | 2025-01-01T00:00:00Z | Predicted Time of Arrival (SeaVantage) | timestamp |
ptaUpdatedAt | 2025-01-01T00:00:00Z | PTA update timestamp | timestamp |
ata | 2025-01-01T00:00:00Z | Actual Time of Arrival | timestamp |
atb | 2025-01-01T00:00:00Z | Actual Time of Berth | timestamp |
atd | 2025-01-01T00:00:00Z | Actual Time of Departure | timestamp |
stopHour | 12.3456 | Vessel idle time from departure of previous port to ATA | double precision |
draught | 12.3456 | Vessel draught information | double precision |
previousDraught | 12.3456 | Vessel draught information before update | double precision |
draughtUpdatedAt | 2025-01-01T00:00:00Z | Vessel draught update timestamp | timestamp |
predictDistance | 12.3456 | Estimated remaining distance from current position to next destination | double precision |
ship | [object Object] | Depth 2 β refer to ship object | |
departurePort | [object Object] | Depth 3 β refer to departurePort object | |
predictedTerminal | [object Object] | Depth 4 β refer to predictedTerminal object | |
arrivalTerminal | [object Object] | Depth 5 β refer to arrivalTerminal object |
Depth 2 Field Description (ship object)
Field | Example Value | Description | Data Type |
shipId | 0260120d-39db-45a4-b22d-83addb409219 | SeaVantage internal unique ship ID | varchar(36) - UUID |
imoNo | 9765988 | Shipβs 7-digit International Maritime Organization (IMO) registration number | varchar(10) |
mmsi | 440027000 | Shipβs 9-digit Maritime Mobile Service Identity (MMSI) registration number | varchar(10) |
callSign | D7BK | Ship's designated international call sign, used in maritime radio communications. | varchar(7) |
shipName | KEOYOUNG BLUE 1 | Official registered name of the vessel | varchar(100) |
shipType | CHEMICAL_TANKER | varchar(36) | |
shipTypeBySize | CHEMICAL_TANKER01 | varchar(36) | |
nationCode | KR | Flag State (Country of Registration) | varchar(36) |
dwt | 1773 | Deadweight tonnage (DWT) | integer |
maxDraught | 4.93 | Maximum draught | real |
Depth 3 Field Description (departurePort object)
Field | Example Value | Description | Data Type |
portId | 47941f60-13b8-4718-bead-aa7c3c61d530 | Internal port identifier used by SeaVantage | varchar(36) - UUID |
portName | Busan | Port name | varchar(255) |
unlocode | KRPUS | Port UNLOCODE | varchar(36) |
nationCode | KR | Country code | varchar(36) |
latitude | 35.1796 | Latitude | double precision |
longitude | 129.0756 | Longitude | double precision |
timezone | +09:00 | Port timezone | varchar(36) |
Depth 4 Field Description (predictedTerminal object)
Field | Example Value | Description | Data Type |
terminalId | 47941f60-13b8-4718-bead-aa7c3c61d530 | Internally used terminal identifier | varchar(36) - UUID |
terminalName | Terminal Name | Terminal name | varchar(128) |
Depth 5 Field Description (arrivalTerminal object)
Field | Example Value | Description | Data Type |
terminalId | 47941f60-13b8-4718-bead-aa7c3c61d530 | Internally used terminal identifier | varchar(36) - UUID |
terminalName | Terminal Name | Terminal name | varchar(128) |
Appendix
Ship Type by Size Classification
Bulk Carrier
Classification Code | Classification | Lower Range (DWT) | Higher Range (DWT) |
BULK 05 | Handysize | 0 | 34,999 |
BULK 04 | Handymax | 35,000 | 59,999 |
BULK 03 | Panamax | 60,000 | 79,999 |
BULK 02 | Capesize | 80,000 | 179,999 |
BULK 01 | VLBC | 180,000 |
Cargo
Classification Code | Classification | Lower Range (DWT) | Higher Range (DWT) |
CARGO 04 | General Cargo | 0 | 2,999 |
CARGO 03 | General Cargo | 3,000 | 7,499 |
CARGO 02 | General Cargo | 7,500 | 37,999 |
CARGO 01 | General Cargo | 38,000 |
Chemical Tanker
Classification | Vessel Type | Classification |
CHEMICAL_TANKER01 | Product Tanker | Chemical tanker, combined chemical and oil tanker |
Container
Classification Code | Classification | Lower Range (TEU) | Higher Range (TEU) |
CONTAINER 07 | Small Feeder | 0 | 1,000 |
CONTAINER 06 | Feeder Containership | 1,001 | 2,000 |
CONTAINER 05 | Feedermax Containership | 2,001 | 3,000 |
CONTAINER 04 | Panamax Containership | 3,001 | 5,100 |
CONTAINER 03 | Post-Panamax Containership | 5,101 | 10,000 |
CONTAINER 02 | Neo-Panamax Containership | 10,001 | 14,500 |
CONTAINER 01 | ULCV Containership | 14,501 |
LNG
Classification Code | Classification | Lower Range (Gross Tonnes) | Higher Range (Gross Tonnes) |
LNG 03 | LNG Gas Carrier | 0 | 73,000 |
LNG 02 | LNG Gas Carrier | 73,001 | 147,000 |
LNG 01 | LNG Gas Carrier | 147,001 |
LPG
Classification Code | Classification | Lower Range (Gross Tonnes) | Higher Range (Gross Tonnes) |
LPG 03 | LPG Gas Carrier | 0 | 4,500 |
LPG 02 | LPG Gas Carrier | 4,501 | 26,000 |
LPG 01 | LPG Gas Carrier | 26,001 |
Pure Car Carrier (PCC)
Classification Code | Classification | Lower Range (Gross Tonnes) | Higher Range (Gross Tonnes) |
PCC 03 | PCC/PCTC | 0 | 35,000 |
PCC 02 | PCC/PCTC | 35,001 | 61,000 |
PCC 01 | PCC/PCTC | 61,001 |
Ro-ro
Classification Code | Classification | Lower Range (Gross Tonnes) | Higher Range (Gross Tonnes) |
RORO 03 | Ro-ro Cargo | 0 | 0 |
RORO 02 | Ro-ro Cargo | 8,501 | 48,000 |
RORO 01 | Ro-ro Cargo | 48,001 |
Tanker
Classification Code | Vessel Type | Classification |
TANKER 05 | Crude Oil Tanker | Tanker- Panamax |
TANKER 04 | Crude Oil Tanker | Tanker- Aframax |
TANKER 03 | Crude Oil Tanker | Tanker- Suezmax |
TANKER 02 | Crude Oil Tanker | Tanker- VLCC |
TANKER 01 | Crude Oil Tanker | Tanker- ULCC |
Product Tanker
Classification | Vessel Type |
PRODUCT_TANKER01 | Product Tanker |
Tug
Classification | Vessel Type |
TUG01 | Tug |
FPSO
Classification | Vessel Type | Classification |
FPSO01 | FPSO | Floating drilling production tanker,
floating gas production,
floating gas storage,
floating LNG production and storage FLNG,
floating power station,
floating production tanker,
floating storage tanker |
ETC
Classification | Vessel Type |
ETC01 | ETC All |