Search Scheduled Vessels

Owned by April Hickson
Last updated: 12 Nov, 2024 by Chris Boxall
2 min read

This end point returns vessel schedule data from our partner ports. It can be filtered by Port, Vessel Type, Arrival status and arrival time. This data is updated approximately every 15 minutes.

Endpoint

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

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

Example Request:

This request will return all vessel schedule data from all our partner ports.

https://api.portconnect.io/v1/scheduled-vessels

 

This request will return all vessel schedule data for Tauranga.

https://api.portconnect.io/v1/scheduled-vessels?portCode=NZTRG

 

This request will return all commercial vessels (excludes cruise ships) for Tauranga that are in port.

 

This request will return all commercial vessels (excludes cruise ships) for Auckland that are expected to arrive between 2nd May 12:00am and 31st May 12:00 am:

 

 

Example Response:

The response data is the same as that returned via the vessel schedule screen on the PortConnect website, and should be self-explanatory.

 

© PortConnect 2023