This API allows you to retrieve the location information of a vessel. If the vessel has not been previously registered, it will be automatically added to the workspace upon lookup.
Authentication
The Fleet 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/fleet/snapshot
Execution Steps
1.
2.
Navigate to the /fleet endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values based on the following Parameters:
•
No input: Retrieves all vessels registered in the workspace.
•
Only categoryId: Retrieves the list of vessels under the specified menu category.
◦
categoryId: Value in UUID format.
◦
•
Only shipId: Retrieves the specified vessel only.
◦
•
Both categoryId + shipId: Retrieves only the specified vessel under the given category.
5.
Click the [Execute] button.
6.
View results in the response section.
Response Information
Sample Response Format
{
"code": 200,
"message": "success",
"error": false,
"timestamp": "2025-05-20T02:09:02.993772679",
"response": [
{
"shipId": "aaa9dcf0-6af2-4f89-a6d5-c25594ed9837",
"position": {
"imoNo": "9637076",
"mmsi": "538005248",
"deviceType": "AIS",
"callSign": "V7CD9",
"shipName": "ARDMORE SEAVANTAGE",
"aisShipType": 80,
"aisDimA": 150,
"aisDimB": 33,
"aisDimC": 8,
"aisDimD": 24,
"aisEta": "05182100",
"aisDestination": "JMKIN",
"staticDateTime": "2025-05-19T00:58:44Z",
"timestamp": "2025-05-19T01:10:11Z",
"aisClass": "A",
"nvgStatus": 0,
"rateOfTurn": 0,
"speedOverGround": 2.0999999046325684,
"positionAccuracy": 0,
"longitude": -76.74852333,
"latitude": 17.96315667,
"courseOverGround": 47.29999923706055,
"trueHeading": 51,
"elapsed": 0,
"utcSecond": 10,
"dte": 0,
"specialManeuverIndicator": "0",
"raimFlag": "0",
"staticMessageNo": 5,
"locationMessageNo": 1,
"aisMaxDraught": 7.8
}
}
]
}
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 | success | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-15T10:56:59.034880881 | Time of response creation (UTC) |
response | Array or Empty Array | An array is returned if the vessel exists; otherwise, an empty array is returned. |
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 |
shipId | aaa9dcf0-6af2-4f89-a6d5-c25594ed9837 | SeaVantage internal unique ship ID | varchar(36) - UUID |
Depth 2 Field Description (position object)
Field | Example Value | Descriptionye | Data Type |
imoNo | 9637076 | Ship’s 7-digit International Maritime Organization (IMO) registration number | varchar(10) |
mmsi | 538005248 | Ship’s 9-digit Maritime Mobile Service Identity (MMSI) registration number | varchar(10) |
deviceType | AIS | AIS Equipment Type | varchar(36) |
callSign | V7CD9 | Ship's designated international call sign, used in maritime radio communications. | varchar(7) |
shipName | ARDMORE SEAVANTAGE | Official registered name of the vessel | varchar(36) |
aisShipType | 80 | Vessel type classification code transmitted via the Automatic Identification System (AIS)
(See separate AIS Ship Type table below) | smallint |
aisDimA | 150 | Distance from the GPS antenna to the bow
(See AIS dimension image below) | smallint |
aisDimB | 33 | Distance from the antenna to the stern
(See AIS dimension image below) | smallint |
aisDimC | 8 | Distance from the antenna to the port (left) side
(See AIS dimension image below) | smallint |
aisDimD | 24 | Distance from the antenna to the starboard (right) side
(See AIS dimension image below) | smallint |
aisEta | 05151000 | AIS Estimated Time of Arrival (ETA) | varchar(8) |
aisDestination | HOUSTON FOR ORDER | AIS Destination | varchar(32) |
staticDateTime | 2025-01-01T00:00:00Z | Static Information Reception Time: Refers to the time when static information about the vessel was last updated. | timestamp |
timestamp | 2025-01-01T00:00:00Z | Position Information Reception Time: Represents the time when the AIS data was received. | timestamp |
aisClass | A | Class of AIS device:
Class A (commercial)
Class B (smaller vessels) | char |
nvgStatus | 0 | Navigational Status
(See Navigational Status table below) | smallint |
rateOfTurn | 0 | Rate at which the vessel is turning, typically in degrees/min. | real |
speedOverGround | 1 | Current vessel speed relative to the Earth’s surface (in knots). | real |
positionAccuracy | 0 | Indicator of GPS precision
1 = high (<= 10 m)
0 = low (> 10 m) = default | smallint |
longitude | -92.09995833 | Vessel’s latest known position coordinate: longitude | numeric(12, 8) |
latitude | 27.45900833 | Vessel’s latest known position coordinates: latitude | numeric(12, 8) |
courseOverGround | 312.8999938964844 | Direction of the vessel’s movement (degrees) | real |
trueHeading | 229 | Vessel’s actual heading direction | smallint |
elapsed | 0 | Time delay (in minutes) since the last position update | integer |
utcSecond | 45 | UTC Second | smallint |
dte | 0 | Data terminal equipment (DTE) ready
0 = available
1 = not available = default | smallint |
specialManeuverIndicator | 0 | 0 = not available = default
1 = not engaged in special maneuver
2 = engaged in special maneuver (i.e.: regional passing arrangement on Inland Waterway) | char |
raimFlag | 0 | Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device
0 = RAIM not in use = default
1 = RAIM in use | char |
staticMessageNo | 5 | Static Message Number | smallint |
locationMessageNo | 1 | Location Message Number | smallint |
aisMaxDraught | 8.1 | Maximum Draught | real |
Appendix
AIS Dimension
Number of bits | Bit fields | Distance (m) | |
A | 9 | Bit 21 - Bit 29 | 0 - 511:
511 = 511m or greater |
B | 9 | Bit 12 - Bit 20 | 0 - 511:
511 = 511m or greater |
C | 6 | Bit 6 - Bit 11 | 0 - 63:
63 = 63m or greater |
D | 6 | Bit 0 - Bit 5 | 0 - 63:
63 = 63m or greater |
The A value should be entered on the vessel’s heading direction (bow).
•
When the reference point of the reported position is unavailable, but dimension information is provided:
◦
A = C = 0, and B ≠ 0, D ≠ 0
•
When both the reference point and dimension information are unavailable:
◦
A = B = C = D = 0 (default)
•
In the message table:
◦
A is the most significant field, D is the least significant field
AIS Ship Type
Type Code | Description | Type Code | Description |
0 | Not available (default) | 58 | Medical Transport |
1–19 | Reserved for future use | 59 | Noncombatant ship according to RR Resolution No. 18 |
20 | Wing in ground (WIG), all ships of this type | 60 | Passenger, all ships of this type |
21 | Wing in ground (WIG), Hazardous category A | 61 | Passenger, Hazardous category A |
22 | Wing in ground (WIG), Hazardous category B | 62 | Passenger, Hazardous category B |
23 | Wing in ground (WIG), Hazardous category C | 63 | Passenger, Hazardous category C |
24 | Wing in ground (WIG), Hazardous category D | 64 | Passenger, Hazardous category D |
25–29 | Wing in ground (WIG), Reserved for future use | 65–68 | Passenger, Reserved for future use |
30 | Fishing | 69 | Passenger, No additional information |
31 | Towing | 70 | Cargo, all ships of this type |
32 | Towing: length exceeds 200m or breadth exceeds 25m | 71 | Cargo, Hazardous category A |
33 | Dredging or underwater ops | 72 | Cargo, Hazardous category B |
34 | Diving ops | 73 | Cargo, Hazardous category C |
35 | Military ops | 74 | Cargo, Hazardous category D |
36 | Sailing | 75–78 | Cargo, Reserved for future use |
37 | Pleasure Craft | 79 | Cargo, No additional information |
38–39 | Reserved | 80 | Tanker, all ships of this type |
40 | High speed craft (HSC), all ships of this type | 81 | Tanker, Hazardous category A |
41 | High speed craft (HSC), Hazardous category A | 82 | Tanker, Hazardous category B |
42 | High speed craft (HSC), Hazardous category B | 83 | Tanker, Hazardous category C |
43 | High speed craft (HSC), Hazardous category C | 84 | Tanker, Hazardous category D |
44 | High speed craft (HSC), Hazardous category D | 85–88 | Tanker, Reserved for future use |
45–48 | High speed craft (HSC), Reserved for future use | 89 | Tanker, No additional information |
49 | High speed craft (HSC), No additional information | 90 | Other Type, all ships of this type |
50 | Pilot Vessel | 91 | Other Type, Hazardous category A |
51 | Search and Rescue vessel | 92 | Other Type, Hazardous category B |
52 | Tug | 93 | Other Type, Hazardous category C |
53 | Port Tender | 94 | Other Type, Hazardous category D |
54 | Anti-pollution equipment | 95–98 | Other Type, Reserved for future use |
55 | Law Enforcement | 99 | Other Type, no additional information |
56–57 | Spare - Local Vessel |
AIS Navigation Status
Code | Status | Description |
0 | Under way using engine | The vessel is actively moving through the water under engine power. |
1 | At anchor | The vessel is anchored and stationary. |
2 | Not under command | The vessel is unable to maneuver due to exceptional circumstances, such as engine failure or loss of steering. Other vessels should navigate with caution. |
3 | Restricted maneuverability | The vessel's ability to maneuver is limited due to operations or environmental conditions. Other vessels should keep clear. |
4 | Constrained by her draught | The vessel is restricted in its ability to deviate from its course due to its deep draught relative to water depth. |
5 | Moored | The vessel is secured by mooring lines, typically tied to a dock or port facility. |
6 | Aground | The vessel has run aground and is stuck in shallow water. It is immobile until freed. |
7 | Engaged in fishing | The vessel is currently engaged in fishing operations. Navigating vessels should allow space, as nets or lines may be deployed. |
8 | Under way sailing | Indicates that the vessel is currently sailing. This may include movement using sails instead of engine power. |
9 | Reserved for future amendment of navigational status | This value is reserved for future use to represent a specific navigation status not yet defined. |
10 | Reserved for future amendment of navigational status | This value is reserved for future use to represent a specific navigation status not yet defined. |
11 | Power-driven vessel towing astern (regional use) | The vessel is towing another vessel behind it. Most commonly used by tugboats. |
12 | Power-driven vessel pushing ahead or towing alongside (regional use) | The vessel is pushing another vessel ahead or towing it alongside. Common in inland waterway operations. |
13 | Reserved for future use | Reserved by standard bodies for future status codes. |
14 | AIS-SART (active), MOB-AIS, EPIRB-AIS | Distress-related AIS devices are active: AIS-SART (Search and Rescue Transponder), MOB-AIS (Man Overboard), or EPIRB-AIS (Emergency Beacon). Immediate attention may be required. |
15 | Undefined = default (also used by AIS-SART, MOB-AIS and EPIRB-AIS under test) | Represents the default status when the vessel’s navigation state is not explicitly defined. |