Contents

What is the PortConnect API?

The PortConnect API (Application programming interface) is a new, more modern way of sending and retrieving data from PortConnect. PortConnect receives container event information 24 hours a day from our partner ports Ports of Auckland, Port of Tauranga, Timaru Container Terminal, Lyttelton Port Company and CentrePort Wellington. Events are received at least every ten minutes.

Signing Up

In order to use the PortConnect API, you need to sign up please see our user-guide for the full instructions on signing up, https://portconnect.atlassian.net/wiki/spaces/PUG/pages/2981330946.

Once signed up, you will be able to subscribe to either the Full Access or Trial product variations for the API, via the "Products" menu. Both products contain the same API endpoints, and both products require you to accept the PortConnect API terms and conditions of use.

All calls to the PortConnect API must include either the primary or secondary key in the header Ocp-Apim-Subscription-Key. You can regenerate your subscription key any time you choose.

Once you sign up for the Trial, the free 3-month trial will commence.

If you sign-up for the Full Access, charges will apply. Please refer to our Pricing page.

Rate Limit

Trial Subscription

Overall cap of 1000 calls in a 24hr period. Limited to 100 calls to any endpoint within 60 seconds.

Full Access Subscription

Overall cap of 40,000 calls in a 24 hour period. Limited to 600 calls to any endpoint within 60 seconds.

Pricing

Please refer to our Pricing page.

A free trial subscription is available for 3-months. To register interest in a trial or for a full access subscription, please contact User Support info@portconnect.co.nz

Developer Portal

Our APIs include:

https://portconnect.atlassian.net/wiki/spaces/PUG/pages/2631237685 : Returns scheduled vessel information, including expected time of arrival and departure.
https://portconnect.atlassian.net/wiki/spaces/PUG/pages/2631237947 : Receive real-time alerts for key vessel information, including changes to ETA and details of vessels omitting a port.
https://portconnect.atlassian.net/wiki/spaces/PUG/pages/2631237711 : Returns the latest detailed information for specified containers. Up to 10 containers can be searched at any one time.
https://portconnect.atlassian.net/wiki/spaces/PUG/pages/2631237749 : This is a suite of operations which allows container events to be sent to any end point or email you specify.
https://portconnect.atlassian.net/wiki/spaces/PUG/pages/2631238040 : Submit export container details to Ports of Auckland, Port of Tauranga and Timaru Container Terminal.
https://portconnect.atlassian.net/wiki/spaces/PUG/pages/1030520860 : PortConnect offers the following endpoints exclusively for the use of shipping lines.
- Bookings
- Storage Pre-Advice
- OCR

Codes

PortConnect uses many codes and a list of our codes can be found here, https://portconnect.atlassian.net/wiki/spaces/PUG/pages/856851240

FAQ

Please see our FAQ page if you have any questions, https://portconnect.atlassian.net/wiki/x/AYCQrw

API Documentation