Retrieve a list of vessels from a name, a MMSI or an IMO.

GET https://api.sinay.ai/ports-vessels/api/v1/vessels?vesselNameOrCode= SORBON&numberOfResult=10

This endpoint is used to retrieve a list of vessels that can match your input.

It will return a list of of none/one/several vessels depending of the result of the search.

If there is no vessel that match your input the vessels list will be empty.

Request Params

KeyDatatypeRequiredDescription
vesselNameOrCodestring(Required) Please enter at least 3 letters of the vessel name, the MMSI or the IMO.
numberOfResultnumberNumber of results per request. Default is 10, minimum is 10, maximum is 100.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"input":"\u003cstring\u003e","vesselsList":[{"name":"\u003cstring\u003e","imo":"\u003cstring\u003e","mmsi":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","imo":"\u003cstring\u003e","mmsi":"\u003cstring\u003e"}]}