Vessel Visit API
Retrieve and share vessel-level data.Easily submit requested and required information.
Service description
With the Vessel Visit API, you have the ability to receive and/or share data at vessel level, with data available from agents, terminals, harbour master and nautical service providers.
Service features
- PaidSubscription fee and/or transaction fee applies.
- System interface (API)The service can be used via an API system interface.
Benefits for your business:
- Customers can receive data from more than 50 different parties with a single connection instead of having to connect to each one individually.
- Data owners do not need to dedicate capacity to continually setting up new connections. Portbase supplies this data only to parties authorized by the data owner.
- Agents and shipping lines can retrieve data – which they manually enter into Portbase – into their own systems by means of an API connection.
- Agents and shipping lines can also send data to Portbase themselves via this connection, eliminating the need for manual input.
Who is it for?
- Software/digital solution providers.
- Everyone involved in the port call process.
The Vessel Visit API enables organizations to retrieve and/or share vessel-level data with parties relevant to them.
The following data is available (click to unfold):
| Data attributee | 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 | |||
| 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 |
Cost
The Vessel Visit API costs €0.67 per port call for which data is received. This is regardless of how many sources data is received from.
In order to use the Vessel Visit API, you also need the MyData application. In MyData you can request data sharing permission (authorization) from the data owners. MyData is automatically available and free of charge to all organizations which are Portbase clients.
However, data owners do have the ability to add conditions to the authorization.
This is how you request this service
To request a service, you need an IAMconnected account that is linked to your organization. More information about the registration process can be found on the Here’s how you connect page. Or download the seven steps of the registration process as pdf.
Login
I already have a IAMconnected account
Do you already have a service connected? In that case you login with your IAMconnected account.
Register
I am a new customer
As a new customer, you create an account first. Then link your account to your organization.
Contact
Request service
Ready to optimize your logistics processes? Request the service directly or contact us. Our experts are ready to answer all your questions and guide you through the process of requesting the desired service.
