This API provides statistical data by ship type and size for a specified period. The provided statistics include the number of vessels en route to the port, the number of vessels waiting for berth, the number of vessels currently berthed, the average waiting time, the average operation time, the number of arriving vessels, and the number of departing vessels.
Authentication
The Port Insight Statistics 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-insight/statistics/ship-type-sizes
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/statistics/ship-type-sizes endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
•
•
from
◦
Start date and time of query (in UTC)
◦
Example: 2025-01-01T00:00:00Z
•
to
◦
End date and time of query (in UTC)
◦
Example: 2025-01-01T00:00:00Z
•
shipTypeBySizes
◦
Ship type size list filter (Refer to the ship type size classification table)
◦
Multiple values supported
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": [
{
"localAggregatedAt": "2025-01-01T00:00:00Z",
"aggregatedAt": "2025-01-01T00:00:00Z",
"onTheWayCount": 10.0,
"waitingCount": 10.0,
"workingCount": 10.0,
"avgStopHour": 12.3456,
"avgWaitingHour": 12.3456,
"avgWorkingHour": 12.3456,
"arrivalCount": 10.0,
"berthingCount": 10.0,
"departureCount": 10.0
}
]
}
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 | Returns an array if data exists; returns an empty array if no data 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 (response object)
Field | Example Value | Description | Data Type |
localAggregatedAt | 2025-01-01T11:30:00Z | Timestamp of statistical aggregation (based on port local time) | timestamp |
aggregatedAt | 2025-01-01T02:30:00Z | Timestamp of statistical aggregation (based on UTC) | timestamp |
onTheWayCount | 10.0 | Number of vessels en route to the port at the time of data generation | real |
waitingCount | 10.0 | Number of vessels waiting to berth at the port at the time of data generation | real |
workingCount | 10.0 | Number of vessels berthing at the port at the time of data generation | real |
avgStopHour | 12.3456 | Average waiting time outside the anchorage area | real |
avgWaitingHour | 12.3456 | Average waiting time within the anchorage area | real |
avgWorkingHour | 12.3456 | Average operation (berth) time | real |
arrivalCount | 10.0 | Number of vessels that has arrived within the last 24 hours | real |
berthingCount | 10.0 | Number of vessels that has berthed within the last 24 hours | real |
departureCount | 10.0 | Number of vessels that has departed within the last 24 hours | real |
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 |
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 |
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 |
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 |