Port traffic and berth data API

Questions that start with a place, not a ship. What is in a port now, what is heading for it, what has moved through it, and how busy its berths have been.

If your question starts with a specific vessel, Vessel & Voyage is the faster route. If it starts with a monitored area instead of a port, see Domain & Fleet.

When to use it

You want to know	Start at
Which port this is, and its identifiers and geometry	Port Insights
Which vessels are alongside or at anchor right now	Port Insights
Which vessels are heading here, and when they expect to arrive	Port Insights
What arrived and departed over a period	Port Insights
How individual berths have been used	Port Insights
How much traffic it handled over a period, and how its berths performed	Port Analytics

What is in it

Port Insights

Find a port, see which vessels are inside it or heading for it, and read its arrival, departure and berth traffic.

Port Analytics

Counts rather than lists: traffic volume bucketed over time, berth dwell statistics, and one berth in full detail.

Paths you will call

https://api.polestar-production.com/zone-port-insights/v1/zones
https://api.polestar-production.com/zone-port-insights/v1/zones/{id}
https://api.polestar-production.com/zone-port-insights/v1/vessels-in-zone-or-port/{id_type}/{id}
https://api.polestar-production.com/zone-port-insights/v1/inbound-vessels/{id_type}/{id}
https://api.polestar-production.com/zone-port-insights/v1/zone-and-port-traffic/{id_type}/{id}
https://api.polestar-production.com/zone-port-insights/v1/port-berth-traffic/{id_type}/{id}
https://api.polestar-production.com/maritime-analytics/v1/analytics/ports/{id_type}/{id}/arrivals-departures
https://api.polestar-production.com/maritime-analytics/v1/analytics/ports/{id_type}/{id}/berths
https://api.polestar-production.com/maritime-analytics/v1/analytics/ports/{id_type}/{id}/berths/{berth_id}

{id_type} says which kind of identifier you are passing, and {id} is the value. A port accepts more than one, so the pair lets you use whichever you already hold.

The analytics endpoints sit behind /maritime-analytics, a base path of their own. Everything else here carries its service prefix in the path itself.

A first call

Take a port identifier from the response, then ask what is inside it:

Two parts of this package are documented elsewhere

The shared Zones & Ports section holds the endpoints that answer for zones and ports alike. They are part of this package, and their endpoint reference lives in that section alone, not under Port & Trade:

The port reads: search ports (GET /zone-port-insights/v1/zones), read one port (/zones/{id}), list the vessels in a port (vessels-in-zone-or-port), and get its arrivals and departures (zone-and-port-traffic)

Port notifications: subscriptions to arrivals, departures and berth events, documented in Zone & Port Notifications. The subscription model is the same for any area and there is no port-specific alternative, so use them

Port Insights walks through the port reads from the port side.

Inbound vessels and berth traffic sit under /zone-port-insights/v1/ as well, but both are Port & Trade endpoints alone, so their reference stays in this section. The prefix names the service that answers a call, not the package that sells it.

Choosing Port Endpoints is the Port & Trade reader's route through both.

Custom zones are not a port capability

A custom zone is a circle or a polygon. The API has no way to define a custom port, so creating your own area is a Domain & Fleet capability and is documented there.

Port traffic events and Port Analytics answer different questions

/zone-port-insights/v1/zone-and-port-traffic returns the underlying arrival and departure events, one row per movement. /v1/analytics/ports/.../arrivals-departures returns aggregates over those events, bucketed by time and vessel attribute. Reach for Port Analytics when you want counts and distributions, and for Port Insights when you want the movements themselves.

Zones & Ports

The zone-and-port endpoints this package draws on.

Zone & Port Types

The taxonomy behind port and area classification.

Vessel Classes

Size and capability classes used to group port traffic.

Port & Trade

When to use it#

What is in it#

Paths you will call#

A first call#

Two parts of this package are documented elsewhere#

Related#

When to use it

What is in it

Paths you will call

A first call

Two parts of this package are documented elsewhere

Related