This API retrieves position information for Class B vessels..
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.
Fleet Request Information
Request URL
Request URL : [GET] https://insight.seavantage.com/api/fleet
Execution Steps
1.
In the Swagger documentation, select NonIMONo(ClassB) from the Select a definition menu in the top-right corner.
2.
Navigate to the /fleet/class-b/snapshot endpoint.
3.
Click [Try it out] to enable the input fields.
4.
The result is returned based on the request Parameters configuration.
•
No parameters: Retrieves all Class B vessels registered in the workspace.
•
categoryId only: Retrieves the list of Class B vessels registered under the specified category.
◦
categoryId must be a UUID.
◦
To add or view the categoryId, contact cx@seavantage.com.
•
shipId only: Retrieves only the specified Class B vessel.
◦
•
categoryId + shipId: Retrieves only the specified Class B vessel within the specified category.
5.
Click [Execute].
6.
Review the result in the response section at the bottom.
Response Information
Response example
{
"code": 200,
"message": "success",
"error": false,
"timestamp": "2025-12-19T07:53:48.541151980",
"response": [
{
"shipId": "01807ed0-dbb0-45b3-a836-e2dff5173dbb",
"position": {
"imoNo": "",
"mmsi": "413833481",
"deviceType": "AIS",
"callSign": null,
"shipName": "ZHONG YI JI TONG",
"aisShipType": 70,
"aisDimA": 10,
"aisDimB": 79,
"aisDimC": 13,
"aisDimD": 3,
"aisEta": "12192200",
"aisDestination": "NAN JING",
"staticDateTime": "2025-12-19T07:16:51Z",
"timestamp": "2025-12-19T07:22:24Z",
"aisClass": "B",
"nvgStatus": 5,
"rateOfTurn": 0,
"speedOverGround": 0,
"positionAccuracy": 1,
"longitude": 118.59328,
"latitude": 31.93993667,
"courseOverGround": 253.89999389648438,
"trueHeading": 0,
"elapsed": 0,
"utcSecond": 21,
"dte": 0,
"specialManeuverIndicator": "0",
"raimFlag": "0",
"staticMessageNo": 5,
"locationMessageNo": 1,
"aisMaxDraught": 2.8
}
}
]
}
EBNF
복사
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 | Deleted |
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 | Description | Data Type |
shipId | 01807ed0-dbb0-45b3-a836-e2dff5173dbb | SeaVantage unique vessel ID | varchar(36) - UUID |
Depth 2 Field Definitions (position object)
Field | Example | Description | Data Type |
imoNo | - | IMO number | varchar(20) |
mmsi | 413833481 | MMSI (Maritime Mobile Service Identity) | varchar(20) |
deviceType | AIS | AIS device type | varchar(36) |
callSign | null | Vessel call sign | varchar(7) |
shipName | ZHONG YI JI TONG | Vessel name | varchar(36) |
aisShipType | 70 | Ship type received from AIS
AIS Ship Type (see table below) | smallint |
aisDimA | 10 | Distance from GPS antenna to bow (A)
AIS Dimension (see figure below) | smallint |
aisDimB | 79 | Distance from GPS antenna to stern (B)
AIS Dimension (see figure below) | smallint |
aisDimC | 13 | Distance from GPS antenna to port side (C)
AIS Dimension (see figure below) | smallint |
aisDimD | 3 | Distance from GPS antenna to starboard side (D)
AIS Dimension (see figure below) | smallint |
aisEta | 12192200 | Estimated Time of Arrival (ETA) reported by AIS | varchar(8) |
aisDestination | NAN JING | Destination reported by AIS | varchar(32) |
staticDateTime | 2025-12-18T05:50:45Z | Timestamp when static AIS data was received | timestamp |
timestamp | 2025-12-18T05:55:08Z | Timestamp when position data was received | timestamp |
aisClass | B | AIS Class
Class A (commercial)
Class B (smaller vessels) | char |
nvgStatus | 0 | Navigation status code
AIS Navigation Status (see table below) | smallint |
rateOfTurn | 0 | Rate of turn | real |
speedOverGround | 7.5 | Speed over ground (SOG) | real |
positionAccuracy | 1 | Position accuracy
1 = high (<= 10 m)
0 = low (> 10 m) = default | smallint |
longitude | 119.96213 | Longtitude | numeric(12, 8) |
latitude | 32.01666167 | Latitude | numeric(12, 8) |
courseOverGround | 320.79998779296875 | 320.79998779296875Course over ground (COG) | real |
trueHeading | 0 | True heading | smallint |
elapsed | 0 | Elapsed time since last update | integer |
utcSecond | 8 | UTC second | smallint |
dte | 0 | Data Terminal Equipment (DTE) ready status
0 = available
1 = not available (default) | smallint |
specialManeuverIndicator | 0 | 0 = not available (default)
1 = not engaged in special maneuver
2 = engaged in special maneuver | char |
raimFlag | 0 | RAIM (Receiver Autonomous Integrity Monitoring) status
0 = not in use (default)
1 = in use | char |
staticMessageNo | 5 | Static message number | smallint |
locationMessageNo | 1 | Position message number | smallint |
aisMaxDraught | 2.8 | Maximum draught reported by AIS | 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 Description
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. |