This API retrieves information on all ports registered in the SeaVantage service.
Authentication
The Port 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/all
Execution Steps
1.
2.
Navigate to the /port/all endpoint.
3.
Click [Try it out] to activate input fields.
4.
Click [Execute].
5.
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": [
{
"portId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 35.1796,
"longitude": 129.0756,
"timezone": "+09:00",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}"
}
]
}
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 |
portId | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Internal port identifier provided by SeaVantage | varchar(36) - UUID |
portName | Busan | Port name | varchar(255) |
unlocode | KRPUS | Port UNLOCODE | varchar(36) |
nationCode | KR | Country code | varchar(36) |
latitude | 35.1796 | Latitude | double precision |
longitude | 129.0756 | Longitude | double precision |
timezone | +09:00 | Port time zone | varchar(36) |
geoData | {\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]} | Port area GeoData | text |