Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
GET https://api.portconnect.io/v1/scheduled-vessels

Query Parameters

By default the API returns all vessel schedule data from all our partner ports. Filters are used for narrowing down the data that is returned. Each filter can only be used with a single value and the filter cannot be repeated in the call - i.e. if you wish to filter for INPORT and DEPARTED vessels then you will need to make two separate calls.

Name

Description

portCode

UN code for the port. NZAKL, NZTRG, NZTIU or NZLYT.

vesselType

Either CRUISE or COMMERCIAL

vesselStatus

One of EXPECTED, INPORT or DEPARTED

arrivalDateFrom

Filters vessels arriving from and including this date. YYYY-MM-DDTHH:MM:SS format

arrivalDateTo

Filters vessles arriving to and including this date. YYYY-MM-DDTHH:MM:SS format

...