Retrieve a list of ports from a name or an unlocode.

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

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

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

If there is no port that match your input the ports list will be empty.

Request Params

KeyDatatypeRequiredDescription
portNameOrCodestring(Required) Please enter at least 3 letters of the port name or the port code.
numberOfResultnumberNumber of results per request. Default is 10, minimum is 10, maximum is 100.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"input":"\u003cstring\u003e","portsList":[{"unlocode":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"unlocode":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}