ports

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

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.

get/ports

Request

Base URL
https://api.sinay.ai/ports-vessels/api/v1
Auth
API key in header API_KEY
TypeScript
https://skmtc.dev/sinay/apis/ports-and-vessels-api/docs/ports/get.ts
A function with typed inputs. Its response is checked against the schema.

portNameOrCodestring required

Please enter at least 3 letters of the port name or the port code.

numberOfResultinteger

Number of results per request. Default is 10, minimum is 10, maximum is 100.

Successful Response

inputstring

{
  "input": "bal",
  "portsList": [
    {
      "unlocode": "USBAL",
      "name": "BALTIMORE"
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.