home

[GET] /port-insight/previous-calling/monthly/ship-type-sizes

This API returns monthly volume data of previous calls based on ship type/size.
  Go to Swagger Documentation

Authentication

The Port Previous Calling 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/previous-calling/monthly/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 /previous-calling/monthly/ship-type-sizes endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
portId (required)
The unique Port ID issued by SeaVantage
Can be obtained through the [GET] /port API
from (required)
Start date and time of query (in UTC)
Example: 2025-01-01T00:00:00Z
to (required)
End date and time of query (in UTC)
Example: 2025-01-01T00:00:00Z
previousCallingNationCode (required)
Filter by the nation code for the previous calling country when querying
shipTypeBySizes (optional)
Multiple values supported
previousCallingPortId (optional)
Port ID filter for the previous calling port
[Can be obtained through the [GET] /port API
previousCallingTerminalId (optional)
Terminal ID filter for the previous calling terminal
Can be obtained through the [GET] /port/terminal API
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.

Response Examples

The response will vary depending on the parameters entered. Please refer to the examples below for each condition:
When only port and nationCode of the previous calling port are specified → Returns the number of vessels and monthly volume for the specified country.
When the nationCode + portId of the previous calling port are specified, → Returns the number of vessels and monthly volume for the specified port.
When the nationCode + portId + terminalId of the previous calling port are specified, → Returns the number of vessels and monthly volume for the specified terminal.

Response Examples (by Condition)

Request Condition
Description
portId + from + to + previousCallingNationCode
Based on the target port → Returns the number of ships and monthly throughput for the previous calling country
portId + from + to + shipTypeBySizes + previousCallingNationCode
Based on ship type/size → Returns the number of ships and monthly throughput for the previous calling country
portId + from + to + previousCallingNationCode + previousCallingPortId
Based on the target port → Returns the number of ships and monthly throughput for the previous calling port
portId + from + to + shipTypeBySizes + previousCallingNationCode + previousCallingPortId
Based on ship type/size → Returns the number of ships and monthly throughput for the previous calling port
portId + from + to + previousCallingNationCode + previousCallingPortId + previousCallingTerminalId
Based on the target port → Returns the number of ships and monthly throughput for the previous calling terminal
portId + from + to + shipTypeBySizes + previousCallingNationCode + previousCallingPortId + previousCallingTerminalId
Based on ship type/size → Returns the number of ships and monthly throughput for the previous calling terminal

Response Structure (Common)

{ "code": 200, "message": "OK", "error": false, "timestamp": "2025-08-20T07:20:58.866535036", "response": [ { "yearMonth": "2025-01", "shipCount": 633, "volume": 7404170 } ] }
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
yearMonth
2025-01
Year-Month
varchar(7)
shipCount
10
Number of Vessels
integer
volume
10
Volume (Unit: DWT)
integer

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