A port is a kind of zone, so one set of endpoints answers for both. This section holds them: the read endpoints and the notification endpoints that zones and ports share.It is shared by Port & Trade and Domain & Fleet and belongs to neither. If you hold one of those packages, what is here is part of it.What is in it#
| Module | What it does |
|---|
| Zone & Port Insights | The read endpoints: search areas, read one, list what is inside it, get entry, exit, arrival and departure traffic |
| Zone & Port Notifications | Subscribe to entries, exits, arrivals and departures for any area, for a vessel or a fleet |
Notifications are shared by design#
The subscription model does not change between a port and a zone: pass an area identifier, pick a delivery method, receive events. There is no port-specific or zone-specific alternative, and none is planned.One set of reads for both kinds of area#
The four read endpoints under /zone-port-insights/v1/ answer for a zone or a port, depending on the identifier you pass:| Endpoint | Answers |
|---|
GET /zone-port-insights/v1/zones | Which zones and ports can I see? |
GET /zone-port-insights/v1/zones/{id} | What exactly does this area cover? |
GET /zone-port-insights/v1/vessels-in-zone-or-port/{id_type}/{id} | Who is inside right now? |
GET /zone-port-insights/v1/zone-and-port-traffic/{id_type}/{id} | Who entered, left, arrived or departed over this period? |
Those four are not the whole prefix. Custom zones, berth traffic and inbound vessels are served from it too, and each is documented in the package that owns it.Which page to read next#
Each package has its own route through this section, written for its own readers:
Choosing Port Endpoints
For Port & Trade readers: how to get a port identifier, read a port through these endpoints, and subscribe to port events.
Choosing Zone Endpoints
For Domain & Fleet readers: zone identifiers, reading a zone through these endpoints, and fleet subscriptions.Identifying an area#
Every area has an identifier and a type and sub-type saying what kind of area it is: an emission control area, a territorial sea, a port, an anchorage, a waterway. Filtering by type gives you a whole class; filtering by sub-type narrows to one kind.Where a path carries {id_type}/{id}, {id_type} names the identifier scheme you are passing and {id} carries the value. A zone is always addressed by ID and its UUID. A port accepts ID or UNLOCODE.Custom zones are not here#
Creating your own area is a Domain & Fleet capability, documented on Custom Zones. A custom zone is a circle or a polygon, and the API has no way to define a custom port, so it is not a shared concern despite sharing a path prefix with these endpoints.
Zone & Port Types
Every type and sub-type, and how to filter by them.
Notifications & Webhooks
Delivery by webhook, email digest or pull.
Port Insights
The four reads from the port side, with worked calls.
Zone Insights
The four reads from the zone side, with worked calls. Modified at 2026-10-15 09:00:17
