This end point returns vessels that are scheduled to arrive at our partner ports. It can also be used to query vessels currently in port and vessels that have recently departed. This data is updated approximately every 15 minutes.
Endpoint
GET https://api.portconnect.io/v1/scheduled-vessels
Query Parameters
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 commercial vessels (excludes cruise ships) for Auckland that are expected to arrive between 2nd May 12:00am and 31st May 12:00 am:
https://api.portconnect.io/v1/scheduled-vessels?portCode=NZAKL&vesselType=COMMERCIAL&vesselStatus=EXPECTED&arrivalDateFrom=2022-05-02&arrivalDateTo=2022-05-31
This request will return all commercial vessels (excludes cruise ships) for Auckland that are expected to arrive between 1:00pm and 2:00pm on the 2nd May. Times are NZ Daylight saving:
https://api.portconnect.io/v1/scheduled-vessels?portCode=NZAKL&vesselType=COMMERCIAL&vesselStatus=EXPECTED&arrivalDateFrom=2022-05-02T13:00:00&arrivalDateTo=2022-05-02T14:00:00
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.
[
{
"vesselVisitReference": "ABCD1234",
"vesselName": "Vessel1",
"imoNumber": 1234567,
"inboundVoyage": "Voyage1",
"alternativeInboundVoyage": null,
"outboundVoyage": null,
"alternativeOutboundVoyage": null,
"vesselStatus": "Expected",
"vesselType": "Cruise",
"portCode": "NZAKL",
"wharfName": null,
"previousPortName": null,
"nextPortName": "NZAUK",
"vesselOperator": "ShippingLine1",
"serviceCode": null,
"arrivalDatetime": "2023-04-15T08:00:00+12:00",
"departureDatetime": null,
"receivalCommenceInland": null,
"receivalCommenceSeaport": null,
"receivalCutoffInland": null,
"rcvCommReeferinland": null,
"rcvCommHazinland": null,
"rcvCutoffHazinland": null,
"rcvCommReeferSeaport": null,
"rcvCommHazSeaport": null,
"rcvCutoffHazSeaport": null,
"receivalCutoffSeaport": null,
"lastUpdatedDateTime": "2023-04-19T20:00:00+12:00",
"visitPhase": "WORKING"
}
]