Inbound Vessels

Production

https://api.polestar-production.com

GET

/zone-port-insights/v1/inbound-vessels/{id_type}/{id}

Retrieve a list of vessels that are reporting the selected zone or port as
their destination in their AIS messages.

The destination reported in a vessel's AIS message is a free-text field and
may contain a port name, UNLOCODE, or other text. Pole Star processes and
normalises this data to identify which vessels are reporting a particular
zone or port as their destination.

For each vessel in the list, the following data is returned:

Vessel Information: Basic vessel information including name, type, IMO
number, MMSI number, and flag.

Reported Destination: Details of the cleaned and parsed destination,
including the matched zone or port id, name, UNLOCODE, the raw AIS
destination value, and the timestamp when it was last updated.

Reported ETA: The ETA as reported in the vessel's AIS message.

Latest Position: The vessel's most recent AIS position report including
speed, course, heading, draught, and navigational status.

Request

Authorization

API Key

Add parameter in header

api-key

Example:

api-key: ********************

Path Params

Query Params

Responses

🟢200OK

application/json

Successful response

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/zone-port-insights/v1/inbound-vessels/id/550e8400-e29b-41d4-a716-446655440001?limit=undefined&offset=undefined&reported_eta_gte=2026-09-15T00%3A00%3A00Z&reported_eta_lte=2026-09-22T00%3A00%3A00Z&last_destination_update_after=2026-09-14T00%3A00%3A00Z&exclude_arrived=undefined' \
--header 'api-key: <api-key>'

Response Example

200 - Inbound vessels for a port by identifier

{
    "meta": {
        "limit": 100,
        "offset": 0,
        "total_count": 1,
        "request_id": "7f3c1b92-0d54-4a6e-9a1f-3c2b8e5d7a10",
        "request_timestamp": "2026-09-15T09:12:44Z"
    },
    "data": [
        {
            "reported_destination": {
                "id": "550e8400-e29b-41d4-a716-446655440001",
                "name": "New York",
                "raw": "NEW YORK",
                "reported_at": "2026-09-14T22:41:00Z",
                "unlocode": "USNYC"
            },
            "reported_eta": "2026-09-16T06:00:00Z",
            "latest_position": {
                "course": 182.4,
                "draught": 11.2,
                "latitude": 40.4912,
                "longitude": -73.9821,
                "navigational_status": {
                    "status": "Under way using engine",
                    "code": 0
                },
                "speed": 12.6,
                "timestamp": "2026-09-15T08:55:12Z",
                "heading": 181
            },
            "vessel_information": {
                "asset_id": "9f21d0c4-52ab-4f77-8a3e-1b6d9c4e7f02",
                "callsign": "WDE5821",
                "imo": "9241061",
                "mmsi": "366999712",
                "name": "EXAMPLE TRADER",
                "flag_code": "US",
                "flag": "United States",
                "vessel_type": "Bulk Carrier"
            }
        }
    ]
}

Modified at 2026-10-21 13:57:11

Berth Calls by Port

Port Analytics