Info API

Vessel & Fleet Management

1️⃣ Obtain the shipId

2️⃣ Add to Fleet (optional)

3️⃣ Delete from Fleet (optional)

4️⃣ Retrieve the list of categoryId (optional)

Vessel Information Retrieval

1️⃣ Vessel Information Retrieval

This API returns key information for vessels registered in the workspace, including vessel specifications, classification details, destination, PTA (Predicted Time of Arrival), PTB (Predicted Time of Berthing), and the associated categoryId. Data is updated approximately every 15 minutes based on AIS data.

Vessel & Fleet Management

Step

Function

Documentation

Obtain the shipId

Retrieve the shipId required for subsequent API calls

[GET] /ship/search

[POST] /ship/match

Add to Fleet (optional)

[POST] /fleet

Delete from Fleet (optional)

Delete one or more vessels from your fleet using the corresponding shipId

[DELETE]/fleet

Retrieve the list of categoryId (optional)

Retrieve all categoryIds available within the workspace

[GET] /fleet/categories

Vessel Information Retrieval

Step

Function

Documentation

Vessel Information Retrieval

Retrieve information for a specified shipId or for vessels registered under a selected fleet categoryId

[GET] /fleet/info

Vessel Information Retrieval Notes

•

If the vessel has already been registered to your fleet, the endpoint will return information for all vessels currently registered in the fleet.

•

If no categoryId is provided, information for all vessels in the fleet will be returned. categoryId is used to organize and manage vessels into custom groups within the workspace. Category setup is not self-service and must be requested through cx@seavantage.com. 

•

If the vessel has not been registered, you may still provide a specific shipId. The API will return information for that vessel only and automatically add it to the fleet upon retrieval.