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
Key | Datatype | Required | Description |
---|---|---|---|
portNameOrCode | string | (Required) Please enter at least 3 letters of the port name or the port code. | |
numberOfResult | number | Number of results per request. Default is 10, minimum is 10, maximum is 100. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"input":"\u003cstring\u003e","portsList":[{"unlocode":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"unlocode":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}