This API returns the next monthly cargo volume data based on the terminal level.
Authentication
The Port Next 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/next-calling/monthly/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/next-calling/monthly/terminals 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.
◦
•
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
•
nextCallingNationCode (required):
◦
Filter by the nation code of the next port of call
•
nextCallingPortId (optional)
◦
Filter by the portId of the next port of call
◦
•
nextCallingTerminalId (optional)
◦
Terminal ID filter for the next calling terminal
◦
The terminal ID 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 the port and the next calling nationCode are provided → Returns the number of vessels and monthly throughput for the specified country
•
When nationCode + portId are provided → Returns the number of vessels and monthly throughput for the specified port
•
When nationCode + portId + terminalId are provided → Returns the number of vessels and monthly throughput for the specified terminal
Response Examples (by Condition)
Request Condition | Description |
portId + from + to + nextCallingNationCode | Port level
→ Returns the number of vessels and monthly throughput for the next calling country |
portId + from + to + terminalIds + nextCallingNationCode | Terminal level (within the port)
→ Returns the number of vessels and monthly throughput for the next calling country |
portId + from + to + nextCallingNationCode + nextCallingPortId | Port level
→ Returns the number of vessels and monthly throughput for the next calling port |
portId + from + to + terminalIds + nextCallingNationCode + nextCallingPortId | Terminal level (within the port)
→ Returns the number of vessels and monthly throughput for the next calling port |
portId + from + to + nextCallingNationCode + nextCallingPortId + nextCallingTerminalId | Port level
→ Returns the number of vessels and monthly throughput for the next calling terminal |
portId + from + to + terminalIds nextCallingNationCode + nextCallingPortId + nextCallingTerminalId | Terminal level (within the port)
→ Returns the number of vessels and monthly throughput for the next 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 |