...
| 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 |
Example Request:
This request will return all vessel schedule data from all our partner ports.
| Code Block |
|---|
https://api.portconnect.io/v1/scheduled-vessels |
This request will return all vessel schedule data for Tauranga.
| Code Block |
|---|
https://api.portconnect.io/v1/scheduled-vessels?portCode=NZTRG |
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:Tauranga that are in port.
| Code Block |
|---|
https://api.portconnect.io/v1/scheduled-vessels?portCode=NZAKLNZTRG&vesselType=COMMERCIAL&vesselStatus=EXPECTED&arrivalDateFrom=2022-05-02&arrivalDateTo=2022-05-31INPORT |
This request will return all commercial vessels (excludes cruise ships) for Tauranga that are in port.Auckland that are expected to arrive between 2nd May 12:00am and 31st May 12:00 am:
| Code Block |
|---|
https://api.portconnect.io/v1/scheduled-vessels?portCode=NZTRGNZAKL&vesselType=COMMERCIAL&vesselStatus=INPORTEXPECTED&arrivalDateFrom=2022-05-02&arrivalDateTo=2022-05-31 |
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.
...