VesselFinder AIS API Documentation

ListManager

Description

The ListManager method manages your list of vessels, used by the VesselsList method.

The changes are reported in the X-API-ADDED-*, X-API-DELETED-* and X-API-REMAINING-SLOTS-* response headers (see Implementation).

Each added vessel uses one slot of your monthly limit (REMAINING_SLOTS in Status). Deleting does not free a slot.

URL format

https://api.vesselfinder.com/listmanager

Parameters

ParameterRequiredTypeDefaultDescription
userkeyyestext-Your personal API key
imoyes*list of integers-List of IMO numbers (comma separated)**
mmsiyes*list of integers-List of MMSI numbers (comma separated)**
  • (*) Not required for GET.
  • (**) IMO numbers, MMSI numbers or both.

Code examples

# Get your list of vessels
curl -i "https://api.vesselfinder.com/listmanager?userkey=YOUR_API_KEY"

# Add vessels to the list
curl -i -X POST https://api.vesselfinder.com/listmanager \
     -d "userkey=YOUR_API_KEY&imo=9175717,9228801&mmsi=227441980"

# Replace all vessels in the list
curl -i -X PUT https://api.vesselfinder.com/listmanager \
     -d "userkey=YOUR_API_KEY&imo=9175717,9228801&mmsi=227441980"

# Delete vessels from the list
curl -i -X DELETE "https://api.vesselfinder.com/listmanager?userkey=YOUR_API_KEY&imo=9175717"

Methods

GET

Get your current list of vessels’ IMO / MMSI numbers.

GET
GET https://api.vesselfinder.com/listmanager?userkey=YOUR_API_KEY

POST

Add new vessel(s) to the list.

POST
POST https://api.vesselfinder.com/listmanager

userkey=YOUR_API_KEY&imo=IMO1,IMO2,IMO3,IMO4&mmsi=MMSI1,MMSI2,MMSI3

PUT

Replace all vessels in your list.

PUT
PUT https://api.vesselfinder.com/listmanager

userkey=YOUR_API_KEY&imo=IMO1,IMO2,IMO3,IMO4&mmsi=MMSI1,MMSI2,MMSI3

DELETE

Delete vessel(s) from your list.

DELETE
DELETE https://api.vesselfinder.com/listmanager?userkey=YOUR_API_KEY&imo=IMO1,IMO2,IMO3,IMO4&mmsi=MMSI1,MMSI2,MMSI3