With the Vessel Visit API you can receive and/or share data at vessel level, including data available from agents, terminals, harbour master and nautical service providers.
Benefits
- One connection only for clients to receive data from more than 50 different parties instead of having to connect to each party individually
- Data owners do not need to deploy capacity to keep setting up connections. Portbase will provide this data only to parties authorized by the data owner
- Agents and shipping companies can use an API connection to unlock the data that they enter manually into Portbase to their own systems
- Agents and shipping companies can also use this connection to enter data into Portbase themselves so that manual input is not required
For whom
- Software/digital solution providers
- Everyone involved in the port call process
The Vessel Visit API allows organizations to retrieve and share vessel-level data with their relevant parties.
The following data are available:
Data attribute Agent Harbour Master Terminal* Pilot (GIDS)
Call Reference Number X X
Client Reference Number X
Vessel > IMO code X X
Vessel > Name X
Owner > Port Authority ID X
Declarant > Port Authority ID X
Owner/Declarant > shortName X
Owner/Declarant > fullName X
Inbound Voyage Number X
PreviousPorts > id X
PreviousPorts > port X
PreviousPorts > arrival X
PreviousPorts > departure X
NextPorts > id X
NextPorts > port X
NextPorts > arrival X
NextPorts > departure X
PortEntry >etaPilotBoardingPlace X
PortEntry > etaSeaBuoy X X
PortEntry > Intention X
Pilot Boarding Place > Code X
Pilot Boarding Place > ETA X
Pilot Boarding Place > ETA Confirmed X
Pilot on board > AT X
First movement > Vessel Draft X
First movement > Order X
Berth > Code X
Berth > Location X
Berth > Mooring X
Berth > Ship side to / Mooring X
Berth > Bollard From/Fore X X
Berth > Bollard Fore Offset X
Berth > Bollard To/Aft X X
Berth > Bollard Aft Offset X
Berth > Arrival > Tugboat > Required Quantity X
Berth > ETA X X
Berth > ETA gangway down (while pilot is on board) X
Berth > ET start cargo handling X
Berth > ATA X X
Berth > AT first line secured X
Berth > AT last line secured X
Berth > AT pilot disembarked X
Berth > AT cargo handling X
Berth > Departure > Tugboat > Required Quantity X
Berth > ETD X X
Berth > ET completion cargo handling X
Berth > AT completion cargo handling X
Berth > AT pilot on board X
Berth > AT first line released X
Berth > AT last line released X
Berth > ATD X X
Next Movement > Vessel Draft X
Next Movement > Order X
Exit Point > Code X
Exit Point > ETD X
Exit Point > ATD X
AT pilot disembarked X
outboundVoyageNumber X
# Data attributes 24 18 16 9
*: ECT Delta, ECT Euromax, RWG, HPD II, APM MVII
Cost
To purchase this service, you will need MyData.
The Vessel Visit API costs €0.67 per port call for which data is received. So this is regardless of how many sources of data are received.
To purchase the Vessel Visit API, you also need the MyData application. In MyData, you can request data share permission (authorisation) from the data owners. MyData is available free of charge for all organisations that are Portbase clients.
However, data owners do have the possibility to add any conditions to the authorisation.
This is how you connect
Sign up here as a new or existing client.
You need a personal IAMconnected account for this service. Follow these steps to create your account.
