This API returns the previous calling cargo volume data based on the terminals of a port.
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/terminals
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/previous-calling/terminals 경로로 이동합니다.
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.
◦
•
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
•
terminalIds (optional)
◦
The unique terminal identifier (Terminal ID) issued by SeaVantage
◦
◦
Supports multiple entries
•
previousCallingNationCode (optional):
◦
Filter by the nation code of the previous port of call
•
previousCallingPortId (optional)
◦
Filter by the portId of the previous port of call
◦
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 (by Condition)
The response will vary depending on the parameters entered. Please refer to the examples below for each condition:
•
When only port and terminal information is provided → Returns the number of vessels and monthly cargo throughput at the country level
•
When nationCode of the previous calling port is provided → Returns the number of vessels and monthly cargo throughput at the port level
•
When nationCode + portId of the previous calling port are provided → Returns the number of vessels and monthly cargo throughput at the terminal level
Entering portId + from + to
•
Based on the selected port → Returns vessel count and monthly volume at the country level
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-18T08:53:58.569647467",
"response": [
{
"key": "CN",
"value": "China",
"shipCount": 100,
"volume": 7099721
}
]
}
JavaScript
복사
Entering portId + from + to + terminalIds
•
Based on a specific terminal within the port → Returns vessel count and monthly volume at the country level
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-18T08:53:58.569647467",
"response": [
{
"key": "CN",
"value": "China",
"shipCount": 100,
"volume": 7099721
}
]
}
JavaScript
복사
Entering portId + from + to + previousCallingNationCode
•
Based on the selected port → Returns vessel count and monthly volume at the port level
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-18T08:56:01.474372636",
"response": [
{
"key": "3ad979b4-9370-11ea-b3ad-049226dae5ce",
"value": "Gwangyang",
"shipCount": 48,
"volume": 1175679
}
]
}
JavaScript
복사
Entering portId + from + to + terminalIds + previousCallingNationCode
•
Based on the selected port → Returns vessel count and monthly volume at the port level
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-18T08:56:01.474372636",
"response": [
{
"key": "3ad979b4-9370-11ea-b3ad-049226dae5ce",
"value": "Gwangyang",
"shipCount": 48,
"volume": 1175679
}
]
}
JavaScript
복사
Entering portId + from + to + previousCallingNationCode + previousCallingPortId
•
Based on the selected port → Returns vessel count and monthly volume at the port level
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-18T08:57:55.601328709",
"response": [
{
"key": "8932aaf6-7882-11ec-a285-049226dae5ce",
"value": "GWANGYANG WEST CONTAINER TERMINAL",
"shipCount": 25,
"volume": 788658
}
]
}
JavaScript
복사
Entering portId + from + to + terminalIds + previousCallingNationCode + previousCallingPortId
•
Based on a specific terminal within the port → Returns vessel count and monthly volume at the port level
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-18T08:57:55.601328709",
"response": [
{
"key": "8932aaf6-7882-11ec-a285-049226dae5ce",
"value": "GWANGYANG WEST CONTAINER TERMINAL",
"shipCount": 25,
"volume": 788658
}
]
}
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 |
key | nationCode, portId, terminalId | Code and ID value of the selected nation/port/terminal | varchar |
value | nationName, portName, terminalName | Name of the selected nation/port/terminal | varchar |
shipCount | 10 | Number of vessels | integer |
volume | 10 | Volume (unit: DWT) | integer |