This API returns key details for vessels registered in the workspace, including vessel specifications, destination, PTA (Predicted Time of Arrival), PTB (Predicted Time of Berthing), and the unique categoryId to which the vessel belongs. If a vessel that is not yet registered is queried, it will be automatically added to the workspace.
Authentication
The Fleet 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/fleet/info
Execution Steps
1.
2.
Navigate to the /fleet/info endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values based on the following Parameters:
•
No input: Retrieves all vessels registered in the workspace.
•
Only categoryId: Retrieves the list of vessels under the specified menu category.
◦
categoryId: Value in UUID format.
◦
•
Only shipId: Retrieves the specified vessel only.
◦
•
Both categoryId + shipId: Retrieves only the specified vessel under the given category.
5.
Click the [Execute] button.
6.
View results in the response section.
Response Information
Sample Response Format
{
"code": 200,
"message": "success",
"error": false,
"timestamp": "2025-08-01T08:46:04.416052576",
"response": [
{
"ship": {
"shipId": "aaa9dcf0-6af2-4f89-a6d5-c25594ed9837",
"imoNo": "9637076",
"mmsi": "538005248",
"callSign": "V7CD9",
"shipName": "ARDMORE SEAVANTAGE",
"shipAliasName": null,
"shipType": "PRODUCT_TANKER",
"shipTypeBySize": "PRODUCT_TANKER01",
"shipTypeCargo": "product tanker",
"built": 2014,
"dwt": 49997,
"hullType": "Double Hull",
"gt": 30030,
"builtBy": "SPP Shipbuilding Company Limited",
"builtAt": "Sacheon",
"loa": 183,
"depth": 19.1,
"maxDraught": 13.08,
"engineBuiltBy": "Doosan Engine Company Limited",
"designedBy": "B&W Diesel A/S",
"serviceSpeed": null,
"nationCode": "MH",
"breadth": 32.2,
"teuCapacity": null,
"liquidCapacity": null,
"destinationPortId": null,
"pta": null,
"ptb": null,
"destinationTerminalName": null,
"destinationUnlocode": null,
"destinationPortName": null
},
"categoryIds": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
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 | 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 (ship object)
Field | Example Value | Description | Data Type |
shipId | aaa9dcf0-6af2-4f89-a6d5-c25594ed9837 | SeaVantage internal unique ship ID | varchar(36) - UUID |
imoNo | 9637076 | Ship’s 7-digit International Maritime Organization (IMO) registration number | varchar(10) |
mmsi | 538005248 | Ship’s 9-digit Maritime Mobile Service Identity (MMSI) registration number | varchar(10) |
callSign | V7CD9 | Ship's designated international call sign, used in maritime radio communications. | varchar(7) |
shipName | ARDMORE SEAVANTAGE | Official registered name of the vessel | varchar(100) |
shipAliasName | null | Ship alias name | varchar(36) |
shipType | PRODUCT_TANKER | varchar(36) | |
shipTypeBySize | PRODUCT_TANKER01 | varchar(36) | |
shipTypeCargo | product tanker | Ship cargo type | varchar(50) |
built | 2014 | Year built | smallint |
dwt | 49997 | Deadweight tonnage (DWT) | integer |
hullType | Double Hull | Hull type | varchar(36) |
gt | 30030 | Gross tonnage (GT) | integer |
builtBy | SPP Shipbuilding Company Limited | Shipbuilder | varchar(200) |
builtAt | Sacheon | Build location | varchar(50) |
loa | 183 | Length overall (LOA) | real |
depth | 19.1 | Total depth | real |
maxDraught | 13.08 | Maximum draught | real |
engineBuiltBy | Doosan Engine Company Limited | Engine manufacturer | varchar(200) |
designedBy | B&W Diesel A/S | Engine designer | varchar(200) |
serviceSpeed | null | Service speed (knots) | real |
nationCode | MH | Flag State (Country of Registration) | varchar(3) |
breadth | 32.2 | Beam (width) | real |
teuCapacity | null | TEU capacity | integer |
liquidCapacity | null | Liquid cargo capacity | integer |
destinationPortId | 9cca705a-a39c-47b9-9a30-629731c80b41 | Internal port identifier used by SeaVantage | varchar(36) - UUID |
pta | 2025-05-12T00:00:00Z | Predicted Time of Arrival (SeaVantage) | timestamp |
ptb | 2025-05-12T00:00:00Z | Predicted Time of Berthing (SeaVantage) | timestamp |
destinationTerminalName | KAO MING TERMINAL (W108-W111) | Destination terminal name | varchar(128) |
destinationUnlocode | TWKHH | Destination UNLOCODE | varchar(36) |
destinationPortName | Kaohsiung | Destination port name | varchar(255) |
Depth 2 Field Description (categoryIds object)
Field | Example | Description | Data Type |
categoryIds | 123e4567-e89b-12d3-a456-426614174000 | SeaVantage internal category unique ID | varchar(36) - UUID |
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 |