# Pole Star Developer Portal ## Docs - Start Here [Insights API documentation | Pole Star Global](https://developers.polestarglobal.com/api-overview.md): The Insights maritime data suite: vessel identity and positions, voyage behaviour, port and zone activity, fleet monitor - Start Here [Getting started with the Pole Star APIs](https://developers.polestarglobal.com/getting-started.md): Create an API key, make your first call, and read the shared response envelope, pagination and error format used across every Pole Star API. - Start Here [API authentication with API keys | Pole Star](https://developers.polestarglobal.com/authentication.md): Authenticate with the api-key header. Create and manage keys in the account service, see which scheme each product uses, and the deprecated JWT flow. - Start Here [Quick start | Pole Star APIs](https://developers.polestarglobal.com/quick-start.md): From an API key to a working call to a generated client, in three steps, plus how to connect an AI assistant to these contracts. - Start Here [Testing and mock servers | Pole Star APIs](https://developers.polestarglobal.com/testing-and-sandbox.md): Exercise the APIs against a mock server without a key, or send real requests with your own key. What each is good for, and a pre-launch checklist. - Concepts & Terminology [Concepts and maritime terminology | Pole Star](https://developers.polestarglobal.com/concepts-and-terminology.md): Vessels, voyages, zones, fleets and subscriptions, how they relate, and the maritime vocabulary in the responses: IMO, MMSI, EEZ, AIS gaps and STS transfers. - Concepts & Terminology [Notifications and webhooks | Pole Star APIs](https://developers.polestarglobal.com/notifications-and-webhooks.md): Subscribe to vessel, fleet, zone and port events. Delivery by webhook, email digest or GET, with the event types and filters you can subscribe to. - Concepts & Terminology [API errors and status codes | Pole Star ](https://developers.polestarglobal.com/errors-and-status-codes.md): The error body returned by every Insights endpoint, what each status code means, when to retry, and how PurpleTRAC's legacy error shapes differ. - Concepts & Terminology [Pagination and filtering | Pole Star APIs](https://developers.polestarglobal.com/pagination-and-filtering.md): Page list results with limit and offset, read total_count from the meta block, and narrow queries by identifier, time window, state or vessel attribute. - Concepts & Terminology [API versioning and deprecation | Pole Star](https://developers.polestarglobal.com/versioning-and-deprecation.md): Versions live in the path and everything is on v1. What ships additively, what triggers a new version, and how deprecation is handled. - Concepts & Terminology [API changelog | Pole Star](https://developers.polestarglobal.com/changelog.md): What changed in the Pole Star APIs and developer portal, newest first: new endpoints, changes, deprecations and removals by product. - Reference Data [Vessel type reference | Pole Star APIs](https://developers.polestarglobal.com/vessel-types.md): The full vessel type list with its detailed and broad categories, for inclusion and exclusion filters on Vessel Search. - Reference Data [Vessel class reference | Pole Star APIs](https://developers.polestarglobal.com/vessel-classes.md): Size and capability classes within each vessel type, used by Port Analytics. VLCC, Suezmax, Capesize, Panamax and the rest, with what constrains them. - Reference Data [Vessel status reference | Pole Star APIs](https://developers.polestarglobal.com/vessel-statuses.md): Lifecycle status values for Vessel Search filters, from projected through in service to broken up, and why a vessel can disappear from your results. - Reference Data [Zone and port type reference | Pole Star APIs](https://developers.polestarglobal.com/zone-and-port-types.md): Every zone type and sub-type: emission control areas, jurisdictional zones, port areas, risk zones, sanctions zones and waterways, and how to filter by them. - Build & Operate [Connect an AI assistant to the API docs](https://developers.polestarglobal.com/ai-assistants-and-agents.md): Connect these contracts to Cursor, Claude Code or Cline over MCP, or use llms.txt and the OpenAPI files, so an agent codes against the real spec. - Build & Operate [Frequently asked questions | Pole Star APIs](https://developers.polestarglobal.com/faq.md): Why port events share a timestamp, snapshot versus history endpoints, custom zone identifiers, test environments and authentication differences. - Build & Operate [Generate an API client from the contract](https://developers.polestarglobal.com/sdks-and-code-generation.md): There is no hand-written SDK. Generate a typed client from the OpenAPI 3.1 contract, and handle pagination, retries and additive change yourself. - Vessel & Voyage [Vessel and voyage data API | Pole Star](https://developers.polestarglobal.com/vessel-voyage.md): Vessel identity, characteristics, port calls, AIS reporting gaps, ship-to-ship pairings and event subscriptions, keyed by IMO. - Vessel & Voyage > Vessel Insights [Vessel search and characteristics API](https://developers.polestarglobal.com/vessel-insights.md): Find a vessel by IMO, MMSI, callsign or name fragment, then read its full profile: dimensions, tonnage, flag, ownership and build detail. - Vessel & Voyage > Voyage Insights [Voyage event API: port calls and AIS gaps](https://developers.polestarglobal.com/voyage-insights.md): Six endpoints returning port calls, zone events, AIS reporting gaps, ship-to-ship pairings, positional discrepancies and inspections by IMO. - Vessel & Voyage > Voyage Insights [Voyage Insights examples | Pole Star APIs](https://developers.polestarglobal.com/voyage-insights-examples.md): Six worked queries: a port call timeline, war risk zone entries, AIS gaps, ship-to-ship transfers, spoofing signals and inspection history. - Vessel & Voyage > Vessel Positions [Consolidated AIS vessel position API](https://developers.polestarglobal.com/vessel-positions.md): Latest positions for a set of vessels, a single vessel's historical track, or everything inside a circle or polygon, from every source you are licensed for. - Vessel & Voyage > Vessel Notifications [Vessel notification subscription examples](https://developers.polestarglobal.com/vessel-notifications-examples.md): Build vessel and fleet event subscriptions: filter shapes for all ten event types, zone filter logic, webhook and email digest delivery. - Port & Trade [Port traffic and berth data API | Pole Star](https://developers.polestarglobal.com/port-trade.md): Find a port, see which vessels are inside it or heading for it, and read arrival, departure and berth-level traffic for congestion work. - Port & Trade [Choosing the right port endpoints | Pole Star](https://developers.polestarglobal.com/choosing-port-endpoints.md): How a Port & Trade reader gets a port identifier, reads a port through the shared zone-and-port endpoints, and subscribes to port events. - Port & Trade > Port Insights [Port data API: vessels, arrivals, berths](https://developers.polestarglobal.com/port-insights.md): Find a port by name, UN/LOCODE or country, see which vessels are inside it now, and read arrival, departure and berth-level traffic. - Port & Trade > Port Analytics [Port traffic and berth analytics API](https://developers.polestarglobal.com/port-analytics.md): Arrival and departure counts bucketed over time and split by vessel type, plus berth dwell statistics and a full detail view of any single berth. - Port & Trade > Port Analytics [Port Analytics: Worked Examples](https://developers.polestarglobal.com/port-analytics-worked-examples-2436151m0.md): - Domain & Fleet [Zone screening and fleet monitoring API | Pole Star](https://developers.polestarglobal.com/domain-fleet.md): Monitor areas and groups of vessels continuously. Zone search and traffic, custom areas, fleet management and standing subscriptions. - Domain & Fleet [Choosing the right zone endpoints | Pole Star](https://developers.polestarglobal.com/choosing-zone-endpoints.md): How a Domain & Fleet reader finds or defines a zone, reads it through the shared zone-and-port endpoints, and subscribes a fleet to zone events. - Domain & Fleet > Zone Insights [Zone API: definitions, occupancy, traffic](https://developers.polestarglobal.com/zone-insights.md): Search zones by type or name, read a zone's definition, list the vessels inside it now, and read its entry and exit history. - Domain & Fleet > Zone Analytics [Zone entry and exit analytics API](https://developers.polestarglobal.com/zone-analytics.md): Entry and exit counts for any zone over a date range, bucketed by day, week, month, quarter or year and grouped by vessel type across all 16 categories. - Domain & Fleet > Zone Analytics [Zone Analytics: Worked Examples](https://developers.polestarglobal.com/zone-analytics-worked-examples-2436153m0.md): - Domain & Fleet > Fleet Management [Fleet management API: group vessels](https://developers.polestarglobal.com/fleet-management.md): Create fleets of vessels and use them as one unit across the APIs. v1 and v2 compared, with the limits, validation and ownership rules. - Domain & Fleet > Fleet Management [Fleet API examples | Pole Star](https://developers.polestarglobal.com/fleet-management-examples.md): Build a fleet in one call, keep membership current, drive a faceted filter UI, and point a notification subscription at the whole group. - Domain & Fleet > Custom Zones [Create custom maritime zones by API](https://developers.polestarglobal.com/custom-zones.md): Draw a circular or polygon area of interest, then search, read and subscribe to it exactly like any other zone. Geometry rules and limits. - Zones & Ports [Zone and port area endpoints | Pole Star APIs](https://developers.polestarglobal.com/zones-and-ports.md): The shared zone-and-port endpoints: search zones and ports, list what is inside them, read entry and exit traffic, and define custom zones. - Zones & Ports > Zone & Port Notifications [Zone and port event notification API](https://developers.polestarglobal.com/zone-and-port-notifications.md): Subscribe to arrivals, departures, entries and exits for chosen ports and zones, with flag filters, screening and webhook or email delivery. - Zones & Ports > Zone & Port Notifications [Zone and port subscription examples](https://developers.polestarglobal.com/zone-and-port-notifications-examples.md): Four area subscriptions built up filter by filter, plus the three ways to read the resulting events back and how to pause one safely. - Start Here [PurpleTRAC API documentation | Pole Star](https://developers.polestarglobal.com/ptrac-overview.md): Screening and tracking for vessels, bills of lading and containers: watchlist checks, movement history, positions, notifications and PDF reports. - Start Here [Getting started with the PurpleTRAC API](https://developers.polestarglobal.com/ptrac-getting-started.md): Find a vessel, submit it for screening, then use the transaction id to read results, enable tracking and download reports across all three workflows. - Start Here [PurpleTRAC API authentication | Pole Star](https://developers.polestarglobal.com/ptrac-authentication.md): Authenticate PurpleTRAC calls with a username and API key sent as query parameters, check they work, and see how 401 and 403 differ from Insights. - Start Here [Testing the PurpleTRAC API | Pole Star](https://developers.polestarglobal.com/ptrac-testing-and-sandbox.md): Exercise PurpleTRAC against a mock server with no credentials, or send real requests with your own, plus a checklist to work through before going live. - Start Here [PurpleTRAC API errors and status codes](https://developers.polestarglobal.com/ptrac-errors-and-status-codes.md): Every PurpleTRAC error shape, including the ones that are plain text or empty, what each status code means, and why 403 signals a disabled feature. - Start Here [PurpleTRAC API FAQ | Pole Star](https://developers.polestarglobal.com/ptrac-faq.md): Why screening can run long, when to archive a transaction, why two movement history sources exist, and how long to leave a vessel under tracking. - Screening [Screen a vessel with the PurpleTRAC API](https://developers.polestarglobal.com/ptrac-screening-vessels.md): Register a vessel for screening, read the transaction response, and walk through fetching each screening result and the PDF report that goes with it. - Screening [Watchlist checks in the PurpleTRAC API](https://developers.polestarglobal.com/ptrac-watchlist-checks.md): Retrieve ship, company and country watchlist check results for a screened vessel, and find the object ids each detailed check endpoint expects. - Screening [Additional PurpleTRAC screening checks](https://developers.polestarglobal.com/ptrac-additional-checks.md): Ship-to-ship pairing, positional discrepancy, flag and company history, P&I club association and operational status checks on a screened vessel. - Screening [Vessel movement history | PurpleTRAC API](https://developers.polestarglobal.com/ptrac-movement-history.md): Retrieve a screened vessel's port call history, understand what each record asserts, and choose between the two movement history sources on offer. - Screening [Vessel carbon rating | PurpleTRAC API](https://developers.polestarglobal.com/ptrac-carbon-rating.md): Retrieve the carbon rating for a screened vessel, see what the response carries, and check whether the carbon rating addon is enabled on your account. - Tracking [Update voyage details | PurpleTRAC API](https://developers.polestarglobal.com/ptrac-voyage-updates.md): Change the voyage and tracking details on a transaction that is already tracking, including which fields accept an update and when the change applies. - Tracking [PurpleTRAC tracking notifications](https://developers.polestarglobal.com/ptrac-notification-catalogue.md): The full catalogue of notification types PurpleTRAC raises on a tracked vessel or bill of lading, what triggers each one, and how to retrieve them. - Tracking [Additional entities on a tracked vessel](https://developers.polestarglobal.com/ptrac-additional-entities.md): Add, list and remove additional entities on a vessel already under tracking, with the ten entity cap and the validation errors you are likely to hit. - Tracking [Track a vessel with the PurpleTRAC API](https://developers.polestarglobal.com/ptrac-vessel-tracking.md): Enable tracking on a screened vessel, follow it through the ready and approved states, read positions and notifications, and collect the trade report. - Bill of Lading [Supported bill of lading carriers](https://developers.polestarglobal.com/ptrac-bl-carriers.md): The carriers PurpleTRAC supports for bill of lading screening and tracking, and what to expect when a bill of lading names a carrier outside the list. - Bill of Lading [Bill of lading verification | PurpleTRAC](https://developers.polestarglobal.com/ptrac-bl-verification.md): Submit a bill of lading for screening, read the verification result, enable tracking to its destination, and download the screening and tracking reports. - Containers [Container screening | PurpleTRAC API](https://developers.polestarglobal.com/ptrac-container-screening.md): Submit a container for screening, use the container screen id to read the result, and download the container report once screening has completed. - Containers [Supported container carriers | PurpleTRAC](https://developers.polestarglobal.com/ptrac-container-carriers.md): The carriers PurpleTRAC supports for container screening, and what happens when a container is submitted against a carrier outside the supported list. - Start Here [MTI API documentation | Pole Star](https://developers.polestarglobal.com/mti-overview.md): Transparency scoring for vessels by IMO number: composite and category scores, portfolio batch screening, and peer comparison by vessel class. - Start Here [MTI API authentication | OAuth 2.0](https://developers.polestarglobal.com/mti-authentication.md): Exchange client credentials for an access token, send it as a bearer token, and read the mti:api scope errors when a token is valid but not permitted. - Start Here [How MTI scores work | 0 to 5 scale](https://developers.polestarglobal.com/mti-understanding-scores.md): The MTI 0 to 5 transparency scale where 5 is best, the five category scores behind the composite, and what the scoring API does not return. - Start Here [Score your first vessel | MTI API](https://developers.polestarglobal.com/mti-getting-started.md): Your first MTI call: fetch a vessel score by IMO number, choose between three levels of detail, and screen a portfolio of up to 500 vessels at once. - [Podium metric timeline API | Pole Star](https://developers.polestarglobal.com/podium.md): The Podium surface inside Vessel and Voyage, what its metric timelines return, the host it answers on and why its credentials differ from Insights. - [Podium API authentication | bearer token](https://developers.polestarglobal.com/podium-authentication.md): Exchange client credentials for a Podium bearer token on the extract-by-imo:metrics scope, send it as a bearer header, and read the 400 and 401 it returns. - [Podium metric timeline API | sensor data](https://developers.polestarglobal.com/podium-metric-io.md): List the metric timelines Podium holds for your vessels, then extract sensor, noon report or voyage summary metrics across a time range. - [Marine weather and sea state API](https://developers.polestarglobal.com/weather.md): Forecast wind, waves, current, ice and ocean chemistry at any position and time, composable with vessel tracks and zone queries. - [Weather API authentication | bearer token](https://developers.polestarglobal.com/weather-authentication.md): Exchange client credentials for a one hour bearer token on the read:weather scope, and read the errors the token and forecast endpoints return. - [Weather forecast API for a position and time](https://developers.polestarglobal.com/numerical-weather-prediction.md): Send a list of parameters and a list of positions, and read forecast values back with the model run and forecast hour each one came from. - [Weather parameter reference | 39 values](https://developers.polestarglobal.com/weather-parameters.md): Every parameter the forecast endpoint accepts, grouped by currents, waves, ice, atmosphere and ocean chemistry, with the unit each name carries. ## API Docs - Vessel & Voyage > Vessel Insights [Vessel Search](https://developers.polestarglobal.com/vessel-search-43396305e0.md): Search for any vessel by name, IMO number, MMSI number, Callsign or Pole - Vessel & Voyage > Vessel Insights [Vessel Characteristics](https://developers.polestarglobal.com/vessel-characteristics-43396304e0.md): Get static vessel information fields for a single vessel. The information - Vessel & Voyage > Voyage Insights [Vessel Port Calls](https://developers.polestarglobal.com/vessel-port-calls-43454449e0.md): Get a list of port-area and port arrivals and departures, as well as - Vessel & Voyage > Voyage Insights [Vessel Zone & Port Events](https://developers.polestarglobal.com/vessel-zone-port-events-43454450e0.md): Get a list of all zone entries and exits and port call events for a - Vessel & Voyage > Voyage Insights [Vessel AIS Reporting Gaps](https://developers.polestarglobal.com/vessel-ais-reporting-gaps-43135621e0.md): Get a vessel's AIS reporting gaps for a given time period. The reporting - Vessel & Voyage > Voyage Insights [Vessel STS Pairings](https://developers.polestarglobal.com/vessel-sts-pairings-43135623e0.md): Get a vessel's Ship to Ship Pairings for a given time period. The pairing - Vessel & Voyage > Voyage Insights [Positional Discrepancies](https://developers.polestarglobal.com/positional-discrepancies-43225284e0.md): Retrieve a list of AIS positional discrepancy events for a single vessel - Vessel & Voyage > Voyage Insights [Port State Control](https://developers.polestarglobal.com/port-state-control-43300545e0.md): Get a list of Port State Control inspections and detentions for a single - Vessel & Voyage > Vessel Positions [Historical Vessel Track](https://developers.polestarglobal.com/historical-vessel-track-44504895e0.md): Returns consolidated historical positions for one vessel (or a - Vessel & Voyage > Vessel Positions [Latest Vessel Positions](https://developers.polestarglobal.com/latest-vessel-positions-44504896e0.md): Returns the most recent consolidated position for each matching vessel. - Vessel & Voyage > Vessel Notifications [Get Vessel Notification Subscriptions](https://developers.polestarglobal.com/get-vessel-notification-subscriptions-43135606e0.md): Every vessel subscription on your account. - Vessel & Voyage > Vessel Notifications [Create Vessel Notification Subscription](https://developers.polestarglobal.com/create-vessel-notification-subscription-43135607e0.md): Subscribe to events for one or more vessels, so movements reach you as - Vessel & Voyage > Vessel Notifications [Get Vessel Notification Subscription](https://developers.polestarglobal.com/get-vessel-notification-subscription-43135608e0.md): Retrieve a single vessel subscription. - Vessel & Voyage > Vessel Notifications [Edit Vessel Notification Subscription](https://developers.polestarglobal.com/edit-vessel-notification-subscription-43135610e0.md): Update a vessel subscription in place. Use this to edit any configuration - Vessel & Voyage > Vessel Notifications [Get Vessel Notifications by Subscription ID](https://developers.polestarglobal.com/get-vessel-notifications-by-subscription-id-43135611e0.md): Notifications raised by one vessel subscription. - Vessel & Voyage > Vessel Notifications [Get All Vessel Notifications](https://developers.polestarglobal.com/get-all-vessel-notifications-43135612e0.md): Every vessel notification raised across all of your subscriptions. - Vessel & Voyage > Vessel Notifications [Delete Vessel Notification Subscription](https://developers.polestarglobal.com/delete-vessel-notification-subscription-43135609e0.md): Remove the subscription from the account. This also removes every - Port & Trade > Port Insights [Berth Calls by Port](https://developers.polestarglobal.com/berth-calls-by-port-43454446e0.md): Get a list of all berth arrival and departure events for vessels at the - Port & Trade > Port Insights [inbound-vessels](https://developers.polestarglobal.com/inbound-vessels-43770137e0.md): Retrieve a list of vessels that are reporting the selected zone or port as - Port & Trade > Port Analytics [Berth KPIs](https://developers.polestarglobal.com/berth-kpis-44504892e0.md): Returns a paginated list of berths at a port together with KPI summary cards - Port & Trade > Port Analytics [Berth Details](https://developers.polestarglobal.com/berth-details-44504893e0.md): Returns all data needed to render the berth detail page in a single response: - Port & Trade > Port Analytics [Port Arrival & Departure Analytics](https://developers.polestarglobal.com/port-arrival-departure-analytics-44504894e0.md): Returns arrival and departure counts for a specified port over a given date - Domain & Fleet > Zone Analytics [Zone Entry & Exit Analytics](https://developers.polestarglobal.com/zone-entry-exit-analytics-44504891e0.md): Returns entry and exit counts for a specified zone over a given date range. - Domain & Fleet > Fleet Management [List Fleets](https://developers.polestarglobal.com/list-fleets-44611418e0.md): Retrieves the fleets created by your account, so you can use them in reporting, dashboards, and analytics. Results are limited to the account tied to the API key sent in the API-KEY header, and an account with no fleets gets an empty list. - Domain & Fleet > Fleet Management [Create Fleet](https://developers.polestarglobal.com/create-fleet-44611921e0.md): Create a fleet and populate it with vessels in a single call. - Domain & Fleet > Fleet Management [Get Fleet Details](https://developers.polestarglobal.com/get-fleet-details-44611419e0.md): Retrieves the details of a single fleet by its identifier, so you can display fleet information in your application or confirm a fleet's setup before working with it. Only active fleets created by your account can be retrieved, and requests are authenticated with your API key in the API-KEY header. - Domain & Fleet > Fleet Management [Delete Fleet](https://developers.polestarglobal.com/delete-fleet-44611922e0.md): Deletes a fleet owned by the signed-in user. The fleet is removed from active fleet lists while its historical record is retained. This request returns no response body. - Domain & Fleet > Fleet Management [Update Fleet](https://developers.polestarglobal.com/update-fleet-44611923e0.md): Rename a fleet, change its description, and add or remove vessels, all - Domain & Fleet > Fleet Management [List Fleet Vessels](https://developers.polestarglobal.com/list-fleet-vessels-44611420e0.md): Retrieves the vessels in one of your fleets, with pagination, filtering, and sorting so you can browse large fleets and find the vessels you need. Only fleets created by your account can be accessed, and requests are authenticated with your API key in the API-KEY header. The mti_score property is included for each vessel only if your account is entitled to the MTI tier-1 feature; otherwise it is omitted. - Domain & Fleet > Fleet Management [Get Fleet Composition](https://developers.polestarglobal.com/get-fleet-composition-45690721e0.md): Return a breakdown of what a fleet is made of, for charting or reporting - Domain & Fleet > Fleet Management [List Fleet Events](https://developers.polestarglobal.com/list-fleet-events-45690722e0.md): List recent events across every vessel in a fleet, most useful for a - Domain & Fleet > Custom Zones [Create Custom Zone](https://developers.polestarglobal.com/create-custom-zone-43454447e0.md): Create a custom circular or polygon zone. - Domain & Fleet > Custom Zones [Edit Custom Zone](https://developers.polestarglobal.com/edit-custom-zone-43454448e0.md): Edit a custom zone definition. - Zones & Ports > Zone & Port Insights [Zone & Port Search](https://developers.polestarglobal.com/zone-port-search-43454442e0.md): Returns zones and ports in one paginated list. This is the unified definition search; the response carries the same port-shaped record for both kinds. - Zones & Ports > Zone & Port Insights [Get Single Zone or Port](https://developers.polestarglobal.com/get-single-zone-or-port-43454443e0.md): Returns the full definition of one zone or port. For an external caller this operation also enforces custom-zone ownership: a custom zone created by another user's account returns 403 rather than the record. - Zones & Ports > Zone & Port Insights [Zone & Port Traffic](https://developers.polestarglobal.com/zone-port-traffic-43454444e0.md): Get a list of all vessels which have entered or exited a zone, or arrived - Zones & Ports > Zone & Port Insights [Vessels in Zone or Port](https://developers.polestarglobal.com/vessels-in-zone-or-port-43454445e0.md): Returns the vessels inside one zone or port now, each with the time it entered, the position it entered at, and its latest known position. - Zones & Ports > Zone & Port Notifications [Create Zone & Port Notification Subscription](https://developers.polestarglobal.com/create-zone-port-notification-subscription-43135614e0.md): Subscribe to events for an area. Part of both **Port & Trade** and - Zones & Ports > Zone & Port Notifications [Get Zone & Port Notification Subscriptions](https://developers.polestarglobal.com/get-zone-port-notification-subscriptions-43135613e0.md): Lists the zone and port notification subscriptions on your account. Part of - Zones & Ports > Zone & Port Notifications [Edit Zone & Port Notification Subscription](https://developers.polestarglobal.com/edit-zone-port-notification-subscription-43135617e0.md): Update an area subscription in place. Use this to edit any configuration - Zones & Ports > Zone & Port Notifications [Delete Zone & Port Notification Subscription](https://developers.polestarglobal.com/delete-zone-port-notification-subscription-43135616e0.md): Remove the subscription from the account. This also removes every - Zones & Ports > Zone & Port Notifications [Get Zone & Port Notification Subscription](https://developers.polestarglobal.com/get-zone-port-notification-subscription-43135615e0.md): Retrieve a single area subscription. Part of both **Port & Trade** and - Zones & Ports > Zone & Port Notifications [Search Zone & Port Notifications](https://developers.polestarglobal.com/search-zone-port-notifications-43135620e0.md): Search the notifications raised by the subscriptions you list in - Zones & Ports > Zone & Port Notifications [Get Zone & Port Notifications by Subscription ID](https://developers.polestarglobal.com/get-zone-port-notifications-by-subscription-id-43135618e0.md): Notifications raised by one subscription. Part of both **Port & Trade** - Zones & Ports > Zone & Port Notifications [Get All Zone & Port Notifications](https://developers.polestarglobal.com/get-all-zone-port-notifications-43135619e0.md): Every area notification raised across all of your subscriptions. Use this - General [Retrieve a list of vessels](https://developers.polestarglobal.com/retrieve-a-list-of-vessels-43814383e0.md): Retrieves all vessels which match the search parameters. You can search for ship by name or IMO Number. If more than one ship matches the name criteria then multiple results will be returned. - General [Additional entity search](https://developers.polestarglobal.com/additional-entity-search-43814384e0.md): Search for additional entities by name, to be included in the vessel screening. - Screening [Submit a vessel for screening](https://developers.polestarglobal.com/submit-a-vessel-for-screening-43814385e0.md): Registers the vessel by providing the IMO number in the body and triggers the screening workflow. - Screening [Retrieve a list of transactions and their screening results](https://developers.polestarglobal.com/retrieve-a-list-of-transactions-and-their-screening-results-43814386e0.md): Get the screening results of a single, some or all transactions. Results can be filtered by: - Screening [Ship & Flag Watchlist check](https://developers.polestarglobal.com/ship-flag-watchlist-check-43814387e0.md): Retrieves all ship and flag sanction checks associated with a particular screening. - Screening [Company Watchlist check](https://developers.polestarglobal.com/company-watchlist-check-43814388e0.md): Retrieves all company sanction checks associated with a screening transaction. - Screening [Country Sanctions check](https://developers.polestarglobal.com/country-sanctions-check-43814389e0.md): Retrieves all company country and flag country check associated with a screening transaction. - Screening [Ship movement history](https://developers.polestarglobal.com/ship-movement-history-43814390e0.md): Retrieves the ship movement history as a list of positions and port calls. - Screening [Ship-to-Ship (STS) pairing screening](https://developers.polestarglobal.com/ship-to-ship-sts-pairing-screening-43814391e0.md): Retrieves Ship-to-Ship (STS) pairing screening results for a transaction: vessels that came alongside the screened vessel, where and when the pairing occurred, its duration, and any matched high-risk zones. - Screening [Company history check](https://developers.polestarglobal.com/company-history-check-43814392e0.md): Retrieves company (ownership/management) history check results: how a vessel's associated companies (registered owner, operator, ship manager, technical manager, group beneficial owner) changed over a lookback period, and the severity of those changes. - Screening [P&I Club check](https://developers.polestarglobal.com/pi-club-check-43814393e0.md): Retrieves the P&I Club (Protection and Indemnity Club) association and sanction-screening result for a screening transaction: the P&I Club a vessel is associated with (or "Unknown" if it couldn't be identified), its calculated severity, and any sanctions matched against that P&I Club company. - Screening [Vessel operational status](https://developers.polestarglobal.com/vessel-operational-status-43814394e0.md): Retrieves the operational status of a vessel at the time it was screened (e.g. broken up, laid up), along with its severity. - Screening [Flag history check](https://developers.polestarglobal.com/flag-history-check-43814395e0.md): Retrieves flag history check results: how a vessel's flag changed over a lookback period, and the severity of those changes. - Screening [AIS positional discrepancy (spoofing) events](https://developers.polestarglobal.com/ais-positional-discrepancy-spoofing-events-43814396e0.md): Retrieves AIS positional discrepancy ("spoofing") events detected for a transaction: e.g. two vessels reporting the same position, box-shaped or circular movement patterns, or MMSI outliers, including the zones and ports involved at the start and stop of the event. - Screening [Periods of Non-Reporting](https://developers.polestarglobal.com/periods-of-non-reporting-43814397e0.md): Get a list of all the periods of non-reporting (AIS) for the vessel across the screening period. - Screening [Carbon rating details](https://developers.polestarglobal.com/carbon-rating-details-43814398e0.md): Retrieves carbon rating score associated with a screening transaction. - Screening [Get the PurpleTRAC Screening Report PDF](https://developers.polestarglobal.com/get-the-purpletrac-screening-report-pdf-43814399e0.md): Retrieves the PurpleTRAC screening report PDF once it has been created. - Screening [Submit a vessel for rescreening](https://developers.polestarglobal.com/submit-a-vessel-for-rescreening-43814400e0.md): Submit a vessel for rescreening after a previous screening has expired. Pole Star considers a vessel screening to be expired 24 hours after it was screened. - Screening [Archive a Screening](https://developers.polestarglobal.com/archive-a-screening-43814401e0.md): Pole Star offers the ability to archive a vessel after screening and/or tracking have concluded. This is also known as deregistering a vessel. - Tracking [Enable a vessel for tracking](https://developers.polestarglobal.com/enable-a-vessel-for-tracking-43814402e0.md): Enable tracking and start generating positional data and event notifications for a vessel. - Tracking [Remove additional entities from a tracked vessel](https://developers.polestarglobal.com/remove-additional-entities-from-a-tracked-vessel-43814403e0.md): Remove one or more additional entities from a vessel which is currently tracking, so that they are no longer screened for the remainder of the tracking period. - Tracking [Add additional entities to a tracked vessel](https://developers.polestarglobal.com/add-additional-entities-to-a-tracked-vessel-43814404e0.md): Add one or more additional entities to a vessel which has already been selected for tracking, so that they are screened alongside the vessel for the remainder of the tracking period. - Tracking [List the additional entities on a transaction](https://developers.polestarglobal.com/list-the-additional-entities-on-a-transaction-43814405e0.md): Retrieve the additional entities which are currently tracked on a transaction. Entities which have been removed are excluded, and the results are ordered by id. - Tracking [Update voyage and tracking details](https://developers.polestarglobal.com/update-voyage-and-tracking-details-43814406e0.md): Update the voyage and tracking configuration of an existing transaction, for example to correct the departure or destination port, add interim ports, change the client reference or extend the tracking expiry. - Tracking [Get vessel positional data](https://developers.polestarglobal.com/get-vessel-positional-data-43814407e0.md): Retrieves the vessel's positional data from when the vessel started tracking. - Tracking [Retrieve a list of vessel or bill of lading notifications](https://developers.polestarglobal.com/retrieve-a-list-of-vessel-or-bill-of-lading-notifications-43814408e0.md): Gets all notifications generated for a vessel or bill of lading while the it is being tracked. To retrieve a vessel's notification include the transaction id in the query path. For a bill of lading's notifications include the blv id instead. - Tracking [Get the PurpleTRAC Trade Report PDF](https://developers.polestarglobal.com/get-the-purpletrac-trade-report-pdf-43814409e0.md): Retrieves the PurpleTRAC Trade report PDF once it has been created. This report is created after a vessel stops tracking. - Bill of Lading [Submit a Bill of Lading for screening](https://developers.polestarglobal.com/submit-a-bill-of-lading-for-screening-43814410e0.md): Registers the bill of lading by providing the SCAC code and BL number in the body and triggers the screening workflow. - Bill of Lading [Get all BL Screening Results](https://developers.polestarglobal.com/get-all-bl-screening-results-43814411e0.md): Retrieve all the available Bill of Lading screening results for the account. - Bill of Lading [Get a single BL screening result](https://developers.polestarglobal.com/get-a-single-bl-screening-result-43814412e0.md): Retrieve the BL Screening results for a single Bill of Lading. - Bill of Lading [Get the PurpleTRAC Bill of Lading Screening Report PDF](https://developers.polestarglobal.com/get-the-purpletrac-bill-of-lading-screening-report-pdf-43814413e0.md): Retrieves the PurpleTRAC screening report PDF for the Bill of Lading once it has been created. - Bill of Lading [Enable tracking for a screened Bill of Lading](https://developers.polestarglobal.com/enable-tracking-for-a-screened-bill-of-lading-43814414e0.md): Enables tracking for a screened Bill of Lading. This will continuously rescreen a bill of lading every 24 hours. - Bill of Lading [Get the PurpleTRAC Bill of Lading Tracking Report PDF](https://developers.polestarglobal.com/get-the-purpletrac-bill-of-lading-tracking-report-pdf-43814415e0.md): Retrieves the PurpleTRAC tracking report PDF for the Bill of Lading once tracking has been disabled. - Bill of Lading [Disable tracking for a Bill of Lading](https://developers.polestarglobal.com/disable-tracking-for-a-bill-of-lading-43814416e0.md): Disables tracking for a screened Bill of Lading. This will end the continuous screening and move the bill of lading status to ARCHIVE. - Containers [Submit a Container for screening](https://developers.polestarglobal.com/submit-a-container-for-screening-43814417e0.md): Registers the container by providing the SCAC code and container number in the body and triggers the screening workflow. - Containers [Get all Container Screening Results](https://developers.polestarglobal.com/get-all-container-screening-results-43814418e0.md): Retrieve all the available Container screening results for the account. - Containers [Archive Container](https://developers.polestarglobal.com/archive-container-43814419e0.md): Archive a screened container. - Containers [Get a single Container screening result](https://developers.polestarglobal.com/get-a-single-container-screening-result-43814420e0.md): Retrieve the Container Screening results for a single container. - Containers [Get the Container report](https://developers.polestarglobal.com/get-the-container-report-43814421e0.md): Retrieve the Container Screening report for a single container. - Vessels [List vessels](https://developers.polestarglobal.com/list-vessels-43988180e0.md): Every vessel we score, filtered on flag, type, status and score range. - Vessels [Get a vessel](https://developers.polestarglobal.com/get-a-vessel-43988181e0.md): One vessel by IMO number: identity, ownership, dimensions, management and - MTI Scores [Get a vessel's scores](https://developers.polestarglobal.com/get-a-vessels-scores-43988182e0.md): The composite MTI score and the five category scores for one vessel: - MTI Scores [Get a vessel's overall score](https://developers.polestarglobal.com/get-a-vessels-overall-score-43988183e0.md): The composite MTI score on its own, with the vessel class it was assessed - MTI Scores [Get scores for several vessels](https://developers.polestarglobal.com/get-scores-for-several-vessels-43988184e0.md): Category scores for up to 500 vessels in one call. Post the IMO numbers - MTI Scores [Get overall scores for several vessels](https://developers.polestarglobal.com/get-overall-scores-for-several-vessels-43988185e0.md): Composite scores for up to 500 vessels in one call, without the category - MTI Scores [Get the score distribution for a vessel class](https://developers.polestarglobal.com/get-the-score-distribution-for-a-vessel-class-43988186e0.md): The precomputed score distribution across a vessel class, so you can - [Extract Timeline Fields](https://developers.polestarglobal.com/extract-timeline-fields-44027254e0.md): Calling this endpoint will return all the metrics in the **specified** timeline for a **specified** time-range. - [Timeline Info for All](https://developers.polestarglobal.com/timeline-info-for-all-44027255e0.md): Calling this endpoint with your security credentials will return the complete set of timelines for every vessel in Podium associated with the account - [Timeline Info by IMO](https://developers.polestarglobal.com/timeline-info-by-imo-44027256e0.md): Calling this endpoint with your security credentials and specific parameters will return only the timelines for the **specified** **IMO**. - Numerical Weather Prediction [Data at a point](https://developers.polestarglobal.com/data-at-a-point-44027258e0.md): Request forecast values at specific places and times. Send the parameters you want in `weatherParams` and the positions in `positionSet`, each one a latitude, a longitude and a UTC timestamp. The response returns a coordinate per position, carrying one value per parameter you asked for, with the model run and forecast hour each value came from. - Numerical Weather Prediction [Get Weather Parameter Details](https://developers.polestarglobal.com/get-weather-parameter-details-44027257e0.md): Get a list of all currently available weather parameters. - Numerical Weather Prediction [Grid data as CSV](https://developers.polestarglobal.com/grid-data-as-csv-45458407e0.md): Exports weather forecast data for multiple locations at once, in CSV format. ## Schemas - [VesselTankerCharacteristicsResponse](https://developers.polestarglobal.com/vesseltankercharacteristicsresponse-18170847d0.md): - [ImoBatchSearchResponse](https://developers.polestarglobal.com/imobatchsearchresponse-18170848d0.md): - [ReportedDestination](https://developers.polestarglobal.com/reporteddestination-17726694d0.md): - [AisFieldDeltaNavigationalStatus](https://developers.polestarglobal.com/aisfielddeltanavigationalstatus-18106340d0.md): - [AisFieldDeltaErrorResponse](https://developers.polestarglobal.com/aisfielddeltaerrorresponse-18106343d0.md): - [BerthDetailsDto](https://developers.polestarglobal.com/berthdetailsdto-17796488d0.md): - [BerthListQuery](https://developers.polestarglobal.com/berthlistquery-17796491d0.md): - [BerthPortInfoDto](https://developers.polestarglobal.com/berthportinfodto-17796493d0.md): - [BerthSummaryDto](https://developers.polestarglobal.com/berthsummarydto-17796494d0.md): - [DwellTimeDataPointDto](https://developers.polestarglobal.com/dwelltimedatapointdto-17796496d0.md): - [OccupancyDto](https://developers.polestarglobal.com/occupancydto-17796498d0.md): - [PortAnalyticsItem](https://developers.polestarglobal.com/portanalyticsitem-17796501d0.md): - [PortAnalyticsQuery](https://developers.polestarglobal.com/portanalyticsquery-17796503d0.md): - [PortAnalyticsResponse](https://developers.polestarglobal.com/portanalyticsresponse-17796504d0.md): - [PortAnalyticsTotals](https://developers.polestarglobal.com/portanalyticstotals-17796505d0.md): - [TopVisitorDto](https://developers.polestarglobal.com/topvisitordto-17796509d0.md): - [VesselTypeMixDto](https://developers.polestarglobal.com/vesseltypemixdto-17796510d0.md): - [ZoneAnalyticsItem](https://developers.polestarglobal.com/zoneanalyticsitem-17796513d0.md): - [ZoneAnalyticsQuery](https://developers.polestarglobal.com/zoneanalyticsquery-17796515d0.md): - [ZoneAnalyticsResponse](https://developers.polestarglobal.com/zoneanalyticsresponse-17796516d0.md): - [ZoneDetail](https://developers.polestarglobal.com/zonedetail-17515229d0.md): - [PortDetail](https://developers.polestarglobal.com/portdetail-17515230d0.md): - [PositionReport](https://developers.polestarglobal.com/positionreport-17515231d0.md): - [PositionalDiscrepancyEvent](https://developers.polestarglobal.com/positionaldiscrepancyevent-17515232d0.md): - [AisSpoofingErrorResponse](https://developers.polestarglobal.com/aisspoofingerrorresponse-18106297d0.md): - [AisSpoofingVesselInformation](https://developers.polestarglobal.com/aisspoofingvesselinformation-18106299d0.md): - [VesselPortsFilter](https://developers.polestarglobal.com/vesselportsfilter-18270874d0.md): - [ZoneDetails](https://developers.polestarglobal.com/zonedetails-17599319d0.md): - [PortDetails](https://developers.polestarglobal.com/portdetails-17599320d0.md): - [CustomZoneDetails](https://developers.polestarglobal.com/customzonedetails-17599321d0.md): - [CircleDetails](https://developers.polestarglobal.com/circledetails-17599322d0.md): - [PortEventDetails](https://developers.polestarglobal.com/porteventdetails-17599324d0.md): - [PortCallEventDetails](https://developers.polestarglobal.com/portcalleventdetails-17599326d0.md): - [BerthInformationPortCall](https://developers.polestarglobal.com/berthinformationportcall-17599328d0.md): - [PortVessel](https://developers.polestarglobal.com/portvessel-17599331d0.md): - [PortListResponse](https://developers.polestarglobal.com/portlistresponse-17599336d0.md): - [ZoneDefinitionResponse](https://developers.polestarglobal.com/zonedefinitionresponse-17599337d0.md): - [CustomZoneResponse](https://developers.polestarglobal.com/customzoneresponse-17599338d0.md): - [ArrivalsDeparturesResponse](https://developers.polestarglobal.com/arrivalsdeparturesresponse-17599339d0.md): - [VesselsInZonePortResponse](https://developers.polestarglobal.com/vesselsinzoneportresponse-17599340d0.md): - [BerthEventsResponse](https://developers.polestarglobal.com/bertheventsresponse-17599341d0.md): - [VoyagePortCallsResponse](https://developers.polestarglobal.com/voyageportcallsresponse-17599342d0.md): - [VoyageZonePortEventsResponse](https://developers.polestarglobal.com/voyagezoneporteventsresponse-17599343d0.md): - [CustomZoneRequest](https://developers.polestarglobal.com/customzonerequest-17599344d0.md): - [CustomCircle](https://developers.polestarglobal.com/customcircle-17599345d0.md): - [ZoneServiceErrorResponse](https://developers.polestarglobal.com/zoneserviceerrorresponse-18106321d0.md): - [ZoneServiceVesselInformation](https://developers.polestarglobal.com/zoneservicevesselinformation-18106324d0.md): - [VesselIdentifier](https://developers.polestarglobal.com/vesselidentifier-17761266d0.md): - [LatestVesselFilter](https://developers.polestarglobal.com/latestvesselfilter-17761267d0.md): - [CircleZone](https://developers.polestarglobal.com/circlezone-17761268d0.md): - [PolygonZone](https://developers.polestarglobal.com/polygonzone-17761269d0.md): - [GeographicFilter](https://developers.polestarglobal.com/geographicfilter-17761270d0.md): - [HistoricalPositionSearchRequest](https://developers.polestarglobal.com/historicalpositionsearchrequest-17761271d0.md): - [LatestPositionSearchRequest](https://developers.polestarglobal.com/latestpositionsearchrequest-17761272d0.md): - [VesselInfo](https://developers.polestarglobal.com/vesselinfo-17761274d0.md): - [MatchedDestination](https://developers.polestarglobal.com/matcheddestination-17761275d0.md): - [ConsolidatedPosition](https://developers.polestarglobal.com/consolidatedposition-17761276d0.md): - [CpsApiErrorResponse](https://developers.polestarglobal.com/cpsapierrorresponse-18106347d0.md): - [CpsApiPaginationMeta](https://developers.polestarglobal.com/cpsapipaginationmeta-18106348d0.md): - [CpsApiNavigationalStatus](https://developers.polestarglobal.com/cpsapinavigationalstatus-18106349d0.md): - [AnalyticsServiceErrorResponse](https://developers.polestarglobal.com/analyticsserviceerrorresponse-18106316d0.md): - [ResponseMeta](https://developers.polestarglobal.com/responsemeta-17578067d0.md): - [FlagDetail](https://developers.polestarglobal.com/flagdetail-17578068d0.md): - [CountryOfBuild](https://developers.polestarglobal.com/countryofbuild-17578069d0.md): - [Ownership](https://developers.polestarglobal.com/ownership-17578070d0.md): - [VesselTankerCharacteristics](https://developers.polestarglobal.com/vesseltankercharacteristics-17578071d0.md): - [VesselCharacteristicsResponse](https://developers.polestarglobal.com/vesselcharacteristicsresponse-17578072d0.md): - [VesselSummary](https://developers.polestarglobal.com/vesselsummary-17578074d0.md): - [VesselSearchResponse](https://developers.polestarglobal.com/vesselsearchresponse-17578075d0.md): - [ImoBatchSearchMeta](https://developers.polestarglobal.com/imobatchsearchmeta-17578076d0.md): - [ImoBatchSearchSummary](https://developers.polestarglobal.com/imobatchsearchsummary-17578077d0.md): - [ImoVesselSummary](https://developers.polestarglobal.com/imovesselsummary-17578078d0.md): - [ImoErrorEntry](https://developers.polestarglobal.com/imoerrorentry-17578079d0.md): - [ImoBatchSearchData](https://developers.polestarglobal.com/imobatchsearchdata-17578080d0.md): - [AssetInformationServiceErrorResponse](https://developers.polestarglobal.com/assetinformationserviceerrorresponse-18106311d0.md): - [AssetInformationServiceDimensions](https://developers.polestarglobal.com/assetinformationservicedimensions-18106312d0.md): - [AssetInformationServiceVesselCharacteristics](https://developers.polestarglobal.com/assetinformationservicevesselcharacteristics-18106313d0.md): - [EmailSettingsDTO](https://developers.polestarglobal.com/emailsettingsdto-17482569d0.md): - [VesselFilterRequestDTO](https://developers.polestarglobal.com/vesselfilterrequestdto-17482572d0.md): - [ZonePortFilterRequestResponseDTO](https://developers.polestarglobal.com/zoneportfilterrequestresponsedto-17482573d0.md): - [SettingsResponseDto](https://developers.polestarglobal.com/settingsresponsedto-17482578d0.md): - [SubscriptionResponseDTO](https://developers.polestarglobal.com/subscriptionresponsedto-17482579d0.md): - [NotificationResponseDTO](https://developers.polestarglobal.com/notificationresponsedto-17482583d0.md): - [EventNotificationServiceMetaData](https://developers.polestarglobal.com/eventnotificationservicemetadata-18106276d0.md): - [BerthEventDetails](https://developers.polestarglobal.com/bertheventdetails-17599325d0.md): - [PscInspection](https://developers.polestarglobal.com/pscinspection-17540871d0.md): - [CustomPolygon](https://developers.polestarglobal.com/custompolygon-17599346d0.md): - [ZoneServiceMeta](https://developers.polestarglobal.com/zoneservicemeta-18106323d0.md): - [HistoricalPositionsResponse](https://developers.polestarglobal.com/historicalpositionsresponse-17761279d0.md): - [FleetListResponse](https://developers.polestarglobal.com/fleetlistresponse-17540876d0.md): - [FleetListMeta](https://developers.polestarglobal.com/fleetlistmeta-17582292d0.md): - [FleetSummary](https://developers.polestarglobal.com/fleetsummary-17582293d0.md): - [FleetItem](https://developers.polestarglobal.com/fleetitem-17582294d0.md): - [VesselPosition](https://developers.polestarglobal.com/vesselposition-17582295d0.md): - [FleetVesselItem](https://developers.polestarglobal.com/fleetvesselitem-17582296d0.md): - [FleetDetailMeta](https://developers.polestarglobal.com/fleetdetailmeta-17582298d0.md): - [FleetDetail](https://developers.polestarglobal.com/fleetdetail-17582299d0.md): - [AnalyticsServiceVesselInformation](https://developers.polestarglobal.com/analyticsservicevesselinformation-18106318d0.md): - [FailedVessel](https://developers.polestarglobal.com/failedvessel-17540879d0.md): - [CreateFleetV2Request](https://developers.polestarglobal.com/createfleetv2request-17540884d0.md): - [CreateFleetV2Response](https://developers.polestarglobal.com/createfleetv2response-17540888d0.md): - [UpdateFleetV2Request](https://developers.polestarglobal.com/updatefleetv2request-17540889d0.md): - [FleetManagementApiMeta](https://developers.polestarglobal.com/fleetmanagementapimeta-18106307d0.md): - [FleetManagementApiErrorResponse](https://developers.polestarglobal.com/fleetmanagementapierrorresponse-18106308d0.md): - [AssetInformationServiceCountryOfBuild](https://developers.polestarglobal.com/assetinformationservicecountryofbuild-18392788d0.md): - [BerthDetailMetaDto](https://developers.polestarglobal.com/berthdetailmetadto-17796485d0.md): - [FleetEventNavigationalStatus](https://developers.polestarglobal.com/fleeteventnavigationalstatus-18392789d0.md): - [LegacyStsPairingsResponse](https://developers.polestarglobal.com/legacystspairingsresponse-18170846d0.md): - [VesselZonesFilter](https://developers.polestarglobal.com/vesselzonesfilter-18270873d0.md): - [EventNotificationServiceErrorResponse](https://developers.polestarglobal.com/eventnotificationserviceerrorresponse-18106275d0.md): - [VesselAisReportingGapsFilter](https://developers.polestarglobal.com/vesselaisreportinggapsfilter-18270875d0.md): - [GapReportingErrorResponse](https://developers.polestarglobal.com/gapreportingerrorresponse-18106280d0.md): - [VesselStsPairingsFilter](https://developers.polestarglobal.com/vesselstspairingsfilter-18270876d0.md): - [VoyageVesselInformation](https://developers.polestarglobal.com/voyagevesselinformation-18271313d0.md): - [StsPairingsResponse](https://developers.polestarglobal.com/stspairingsresponse-17482590d0.md): - [VesselPositionalDiscrepanciesFilter](https://developers.polestarglobal.com/vesselpositionaldiscrepanciesfilter-18270877d0.md): - [VesselDraughtChangeFilter](https://developers.polestarglobal.com/vesseldraughtchangefilter-18270878d0.md): - [PscInspectionServiceErrorResponse](https://developers.polestarglobal.com/pscinspectionserviceerrorresponse-18106302d0.md): - [ReportingStatus](https://developers.polestarglobal.com/reportingstatus-18170849d0.md): - [VesselAisDestinationChangeFilter](https://developers.polestarglobal.com/vesselaisdestinationchangefilter-18270879d0.md): - [DaysNotReportingRange](https://developers.polestarglobal.com/daysnotreportingrange-18170850d0.md): - [VesselAisEtaChangeFilter](https://developers.polestarglobal.com/vesselaisetachangefilter-18270880d0.md): - [AnalyticsServiceMeta](https://developers.polestarglobal.com/analyticsservicemeta-18392790d0.md): - [VesselMmsiChangeFilter](https://developers.polestarglobal.com/vesselmmsichangefilter-18270881d0.md): - [FleetInformation](https://developers.polestarglobal.com/fleetinformation-18392791d0.md): - [VesselNavigationalStatusChangeFilter](https://developers.polestarglobal.com/vesselnavigationalstatuschangefilter-18270882d0.md): - [FleetCompositionResponse](https://developers.polestarglobal.com/fleetcompositionresponse-18392792d0.md): - [CompositionData](https://developers.polestarglobal.com/compositiondata-18392793d0.md): - [VesselInboundBaseResponse](https://developers.polestarglobal.com/vesselinboundbaseresponse-17726692d0.md): - [Summary](https://developers.polestarglobal.com/summary-18392794d0.md): - [TypeAndClass](https://developers.polestarglobal.com/typeandclass-18392795d0.md): - [RegistrationAndFlag](https://developers.polestarglobal.com/registrationandflag-18392796d0.md): - [AnalyticsServiceCountryOfBuild](https://developers.polestarglobal.com/analyticsservicecountryofbuild-18392797d0.md): - [BuildAndOrigin](https://developers.polestarglobal.com/buildandorigin-18392798d0.md): - [SizeAndDimensions](https://developers.polestarglobal.com/sizeanddimensions-18392799d0.md): - [CategoryItem](https://developers.polestarglobal.com/categoryitem-18392800d0.md): - [ChartSection](https://developers.polestarglobal.com/chartsection-18392801d0.md): - [RankedSection](https://developers.polestarglobal.com/rankedsection-18392802d0.md): - [BerthDetailQueryDto](https://developers.polestarglobal.com/berthdetailquerydto-17796486d0.md): - [SizeSection](https://developers.polestarglobal.com/sizesection-18392803d0.md): - [DimensionsSection](https://developers.polestarglobal.com/dimensionssection-18392804d0.md): - [AisGapStartedPosition](https://developers.polestarglobal.com/aisgapstartedposition-18392805d0.md): - [AisGapEndedPosition](https://developers.polestarglobal.com/aisgapendedposition-18392806d0.md): - [ZoneCentroid](https://developers.polestarglobal.com/zonecentroid-18392807d0.md): - [GapReportingMetaData](https://developers.polestarglobal.com/gapreportingmetadata-18106281d0.md): - [ZoneInformation](https://developers.polestarglobal.com/zoneinformation-18392808d0.md): - [StsPairingServiceMeta](https://developers.polestarglobal.com/stspairingservicemeta-18106287d0.md): - [PscPortInformation](https://developers.polestarglobal.com/pscportinformation-18392809d0.md): - [AisSpoofingMeta](https://developers.polestarglobal.com/aisspoofingmeta-18106298d0.md): - [FleetEventsResponse](https://developers.polestarglobal.com/fleeteventsresponse-18392810d0.md): - [PscInspectionServiceMetaData](https://developers.polestarglobal.com/pscinspectionservicemetadata-18106303d0.md): - [FleetEventsData](https://developers.polestarglobal.com/fleeteventsdata-18392811d0.md): - [ZoneServicePaginationMeta](https://developers.polestarglobal.com/zoneservicepaginationmeta-18106322d0.md): - [EventVesselInformation](https://developers.polestarglobal.com/eventvesselinformation-18392812d0.md): - [VesselInbound](https://developers.polestarglobal.com/vesselinbound-17726693d0.md): - [ZoneEventDetails](https://developers.polestarglobal.com/zoneeventdetails-18392813d0.md): - [ZoneEventResponse](https://developers.polestarglobal.com/zoneeventresponse-18392814d0.md): - [Schedule](https://developers.polestarglobal.com/schedule-17482568d0.md): - [AisGapEventResponse](https://developers.polestarglobal.com/aisgapeventresponse-18392815d0.md): - [StsPairingEventResponse](https://developers.polestarglobal.com/stspairingeventresponse-18392816d0.md): - [StsPairedVessel](https://developers.polestarglobal.com/stspairedvessel-18392817d0.md): - [PositionalDiscrepancyEventResponse](https://developers.polestarglobal.com/positionaldiscrepancyeventresponse-18392818d0.md): - [Centroid](https://developers.polestarglobal.com/centroid-17515228d0.md): - [DiscrepancyPositionStart](https://developers.polestarglobal.com/discrepancypositionstart-18392819d0.md): - [DiscrepancyPositionEnd](https://developers.polestarglobal.com/discrepancypositionend-18392820d0.md): - [PscEventResponse](https://developers.polestarglobal.com/psceventresponse-18392821d0.md): - [BerthDetailResponseDto](https://developers.polestarglobal.com/berthdetailresponsedto-17796487d0.md): - [GapEventsResponse](https://developers.polestarglobal.com/gapeventsresponse-17482584d0.md): - [StsPairingsData](https://developers.polestarglobal.com/stspairingsdata-17482592d0.md): - [PscInspectionsResponse](https://developers.polestarglobal.com/pscinspectionsresponse-17540869d0.md): - [Point](https://developers.polestarglobal.com/point-17599318d0.md): - [GapEventData](https://developers.polestarglobal.com/gapeventdata-17482585d0.md): - [StsPairingEvent](https://developers.polestarglobal.com/stspairingevent-17482593d0.md): - [PscInspectionData](https://developers.polestarglobal.com/pscinspectiondata-17540870d0.md): - [LatestPosition](https://developers.polestarglobal.com/latestposition-17726695d0.md): - [VesselScreening](https://developers.polestarglobal.com/vesselscreening-17482570d0.md): - [GapEvent](https://developers.polestarglobal.com/gapevent-17482586d0.md): - [Location](https://developers.polestarglobal.com/location-17482594d0.md): - [BerthKpiDto](https://developers.polestarglobal.com/berthkpidto-17796489d0.md): - [FlagCodesDTO](https://developers.polestarglobal.com/flagcodesdto-17482571d0.md): - [PortInformation](https://developers.polestarglobal.com/portinformation-17540872d0.md): - [BerthListMeta](https://developers.polestarglobal.com/berthlistmeta-17796490d0.md): - [GapPosition](https://developers.polestarglobal.com/gapposition-17482587d0.md): - [StsPairingServiceVesselInformation](https://developers.polestarglobal.com/stspairingservicevesselinformation-18106288d0.md): - [AnalyticsServiceNavigationalStatus](https://developers.polestarglobal.com/analyticsservicenavigationalstatus-18106317d0.md): - [AisFieldDeltaVesselInformation](https://developers.polestarglobal.com/aisfielddeltavesselinformation-18106341d0.md): - [VesselStatus](https://developers.polestarglobal.com/vesselstatus-17540878d0.md): - [GapReportingNavigationalStatus](https://developers.polestarglobal.com/gapreportingnavigationalstatus-18106282d0.md): - [StsPairingServiceErrorResponse](https://developers.polestarglobal.com/stspairingserviceerrorresponse-18106289d0.md): - [PscInspectionServiceVesselInformation](https://developers.polestarglobal.com/pscinspectionservicevesselinformation-18106304d0.md): - [AisFieldDeltaMetaData](https://developers.polestarglobal.com/aisfielddeltametadata-18106342d0.md): - [BerthListResponseDto](https://developers.polestarglobal.com/berthlistresponsedto-17796492d0.md): - [GapReportingVesselInformation](https://developers.polestarglobal.com/gapreportingvesselinformation-18106283d0.md): - [VesselSettingsRequestDto](https://developers.polestarglobal.com/vesselsettingsrequestdto-17482574d0.md): - [LegacyMeta](https://developers.polestarglobal.com/legacymeta-17482596d0.md): - [PolygonDetails](https://developers.polestarglobal.com/polygondetails-17599323d0.md): - [PositionalDiscrepancyData](https://developers.polestarglobal.com/positionaldiscrepancydata-17515233d0.md): - [ZonePortSettingsRequestDto](https://developers.polestarglobal.com/zoneportsettingsrequestdto-17482575d0.md): - [FleetVesselListResponse](https://developers.polestarglobal.com/fleetvessellistresponse-17540883d0.md): - [VesselFlag](https://developers.polestarglobal.com/vesselflag-17761273d0.md): - [LegacyStsPairingsData](https://developers.polestarglobal.com/legacystspairingsdata-17482597d0.md): - [PositionalDiscrepancyResponse](https://developers.polestarglobal.com/positionaldiscrepancyresponse-17515234d0.md): - [VesselSubscriptionRequestDTO](https://developers.polestarglobal.com/vesselsubscriptionrequestdto-17482576d0.md): - [LegacyStsPairing](https://developers.polestarglobal.com/legacystspairing-17482598d0.md): - [BerthTerminalGroupDto](https://developers.polestarglobal.com/berthterminalgroupdto-17796495d0.md): - [ZoneServiceNavigationalStatus](https://developers.polestarglobal.com/zoneservicenavigationalstatus-18106325d0.md): - [ZonePortSubscriptionRequestDTO](https://developers.polestarglobal.com/zoneportsubscriptionrequestdto-17482577d0.md): - [LegacyPairedVessel](https://developers.polestarglobal.com/legacypairedvessel-17482599d0.md): - [UpdateFleetV2Response](https://developers.polestarglobal.com/updatefleetv2response-17540892d0.md): - [StsPairingServiceVesselCharacteristics](https://developers.polestarglobal.com/stspairingservicevesselcharacteristics-18106290d0.md): - [MaritimeAnalyticsBeErrorResponse](https://developers.polestarglobal.com/maritimeanalyticsbeerrorresponse-18106339d0.md): - [FleetSummaryV2](https://developers.polestarglobal.com/fleetsummaryv2-17540885d0.md): - [FleetDetailResponse](https://developers.polestarglobal.com/fleetdetailresponse-17582300d0.md): - [GapDto](https://developers.polestarglobal.com/gapdto-17796497d0.md): - [StsPairingServiceDimensions](https://developers.polestarglobal.com/stspairingservicedimensions-18106291d0.md): - [VesselIdentifiers](https://developers.polestarglobal.com/vesselidentifiers-17482602d0.md): - [RejectedVessels](https://developers.polestarglobal.com/rejectedvessels-17540886d0.md): - [BerthInformation](https://developers.polestarglobal.com/berthinformation-17599327d0.md): - [VesselPositionsGroup](https://developers.polestarglobal.com/vesselpositionsgroup-17761277d0.md): - [SubscriptionSingleResponseDTO](https://developers.polestarglobal.com/subscriptionsingleresponsedto-17482580d0.md): - [VesselResultsSummary](https://developers.polestarglobal.com/vesselresultssummary-17540887d0.md): - [LatestVesselPositionItem](https://developers.polestarglobal.com/latestvesselpositionitem-17761278d0.md): - [OccupancyPaginationDto](https://developers.polestarglobal.com/occupancypaginationdto-17796499d0.md): - [SubscriptionsResponseDTO](https://developers.polestarglobal.com/subscriptionsresponsedto-17482581d0.md): - [SubscriptionIdsRequestDTO](https://developers.polestarglobal.com/subscriptionidsrequestdto-17482582d0.md): - [VesselEntryDetails](https://developers.polestarglobal.com/vesselentrydetails-17599329d0.md): - [PortAnalyticsDataEntry](https://developers.polestarglobal.com/portanalyticsdataentry-17796500d0.md): - [LatestPositionDetails](https://developers.polestarglobal.com/latestpositiondetails-17599330d0.md): - [LatestPositionsResponse](https://developers.polestarglobal.com/latestpositionsresponse-17761280d0.md): - [FleetSummaryV2Update](https://developers.polestarglobal.com/fleetsummaryv2update-17540890d0.md): - [PortAnalyticsMeta](https://developers.polestarglobal.com/portanalyticsmeta-17796502d0.md): - [VesselResultsDetail](https://developers.polestarglobal.com/vesselresultsdetail-17540891d0.md): - [ZonePortVessel](https://developers.polestarglobal.com/zoneportvessel-17599332d0.md): - [BerthEvent](https://developers.polestarglobal.com/berthevent-17599333d0.md): - [VoyagePortCall](https://developers.polestarglobal.com/voyageportcall-17599334d0.md): - [VoyagePortZoneEvent](https://developers.polestarglobal.com/voyageportzoneevent-17599335d0.md): - [PortDwellSeriesEntryDto](https://developers.polestarglobal.com/portdwellseriesentrydto-17796506d0.md): - [PortInfoDto](https://developers.polestarglobal.com/portinfodto-17796507d0.md): - [TopVesselDto](https://developers.polestarglobal.com/topvesseldto-17796508d0.md): - [VesselVisitDto](https://developers.polestarglobal.com/vesselvisitdto-17796511d0.md): - [ZoneAnalyticsDataEntry](https://developers.polestarglobal.com/zoneanalyticsdataentry-17796512d0.md): - [ZoneAnalyticsMeta](https://developers.polestarglobal.com/zoneanalyticsmeta-17796514d0.md): - [ZoneAnalyticsTotals](https://developers.polestarglobal.com/zoneanalyticstotals-17796517d0.md): - [ZoneInfoDto](https://developers.polestarglobal.com/zoneinfodto-17796518d0.md): - [BLVGetAllResultsResponse](https://developers.polestarglobal.com/blvgetallresultsresponse-17754943d0.md): - [BLVScreeningResponse](https://developers.polestarglobal.com/blvscreeningresponse-17754944d0.md): - [BLVLastScreeningResult](https://developers.polestarglobal.com/blvlastscreeningresult-17754945d0.md): - [BLVScreeningResultDetails](https://developers.polestarglobal.com/blvscreeningresultdetails-17754946d0.md): - [ContainerRegistrationBody](https://developers.polestarglobal.com/containerregistrationbody-17754947d0.md): - [ContainerRegistrationResponse](https://developers.polestarglobal.com/containerregistrationresponse-17754948d0.md): - [ContainerGetAllResultsResponse](https://developers.polestarglobal.com/containergetallresultsresponse-17754949d0.md): - [ContainerScreeningResponse](https://developers.polestarglobal.com/containerscreeningresponse-17754950d0.md): - [CarbonRatings](https://developers.polestarglobal.com/carbonratings-17754951d0.md): - [CarbonRating](https://developers.polestarglobal.com/carbonrating-17754952d0.md): - [CompanySanctions](https://developers.polestarglobal.com/companysanctions-17754953d0.md): - [CompanySanction](https://developers.polestarglobal.com/companysanction-17754954d0.md): - [CountryChecks](https://developers.polestarglobal.com/countrychecks-17754955d0.md): - [CountryCheck](https://developers.polestarglobal.com/countrycheck-17754956d0.md): - [StsPairings](https://developers.polestarglobal.com/stspairings-17754957d0.md): - [StsPairing](https://developers.polestarglobal.com/stspairing-17754958d0.md): - [OtherAssociations](https://developers.polestarglobal.com/otherassociations-17754959d0.md): - [OtherAssociation](https://developers.polestarglobal.com/otherassociation-17754960d0.md): - [CompanyHistoryChecks](https://developers.polestarglobal.com/companyhistorychecks-17754961d0.md): - [CompanyHistoryCheck](https://developers.polestarglobal.com/companyhistorycheck-17754962d0.md): - [ShipStatuses](https://developers.polestarglobal.com/shipstatuses-17754963d0.md): - [ShipStatus](https://developers.polestarglobal.com/shipstatus-17754964d0.md): - [FlagHistoryChecks](https://developers.polestarglobal.com/flaghistorychecks-17754965d0.md): - [FlagHistoryCheck](https://developers.polestarglobal.com/flaghistorycheck-17754966d0.md): - [PositionalDiscrepancies](https://developers.polestarglobal.com/positionaldiscrepancies-17754967d0.md): - [PositionalDiscrepancy](https://developers.polestarglobal.com/positionaldiscrepancy-17754968d0.md): - [DiscrepancyZone](https://developers.polestarglobal.com/discrepancyzone-17754969d0.md): - [DiscrepancyPort](https://developers.polestarglobal.com/discrepancyport-17754970d0.md): - [NonReportingResponse](https://developers.polestarglobal.com/nonreportingresponse-17754971d0.md): - [NonReporting](https://developers.polestarglobal.com/nonreporting-17754972d0.md): - [Notifications](https://developers.polestarglobal.com/notifications-17754973d0.md): - [Notification](https://developers.polestarglobal.com/notification-17754974d0.md): - [BLVNotification](https://developers.polestarglobal.com/blvnotification-17754975d0.md): - [BLVPortFull](https://developers.polestarglobal.com/blvportfull-17754976d0.md): - [BLVPortFallback](https://developers.polestarglobal.com/blvportfallback-17754977d0.md): - [PortCallHistory](https://developers.polestarglobal.com/portcallhistory-17754978d0.md): - [PortCallHistoryItem](https://developers.polestarglobal.com/portcallhistoryitem-17754979d0.md): - [Positions](https://developers.polestarglobal.com/positions-17754980d0.md): - [Position](https://developers.polestarglobal.com/position-17754981d0.md): - [PositionInfo](https://developers.polestarglobal.com/positioninfo-17754982d0.md): - [RegistrationResponse](https://developers.polestarglobal.com/registrationresponse-17754983d0.md): - [ShipDetails](https://developers.polestarglobal.com/shipdetails-17754984d0.md): - [ShipSanctions](https://developers.polestarglobal.com/shipsanctions-17754985d0.md): - [ShipSanction](https://developers.polestarglobal.com/shipsanction-17754986d0.md): - [VesselTrackingResponse](https://developers.polestarglobal.com/vesseltrackingresponse-17754987d0.md): - [VesselTransactionsResponse](https://developers.polestarglobal.com/vesseltransactionsresponse-17754988d0.md): - [Transaction](https://developers.polestarglobal.com/transaction-17754989d0.md): - [TransactionPutBody](https://developers.polestarglobal.com/transactionputbody-17754990d0.md): - [TransactionPutResponse](https://developers.polestarglobal.com/transactionputresponse-17754991d0.md): - [TransactionRescreenResponse](https://developers.polestarglobal.com/transactionrescreenresponse-17754992d0.md): - [LastPosition](https://developers.polestarglobal.com/lastposition-17754993d0.md): - [ScreeningNotification](https://developers.polestarglobal.com/screeningnotification-17754994d0.md): - [ScreeningResult](https://developers.polestarglobal.com/screeningresult-17754995d0.md): - [UserDetails](https://developers.polestarglobal.com/userdetails-17754996d0.md): - [UserProfile](https://developers.polestarglobal.com/userprofile-17754997d0.md): - [Error](https://developers.polestarglobal.com/error-17754998d0.md): - [InvalidContainerNumberResponse](https://developers.polestarglobal.com/invalidcontainernumberresponse-17754999d0.md): - [VesselRegistrationBody](https://developers.polestarglobal.com/vesselregistrationbody-17755000d0.md): - [VesselTrackingRequest](https://developers.polestarglobal.com/vesseltrackingrequest-17755001d0.md): - [BLRegistrationBody](https://developers.polestarglobal.com/blregistrationbody-17755002d0.md): - [AdditionalEntitySearchResponse](https://developers.polestarglobal.com/additionalentitysearchresponse-17755003d0.md): - [AdditionalEntity](https://developers.polestarglobal.com/additionalentity-17755004d0.md): - [AdditionalEntitiesRequestSchema](https://developers.polestarglobal.com/additionalentitiesrequestschema-17755005d0.md): - [TrackingAdditionalEntity](https://developers.polestarglobal.com/trackingadditionalentity-17755006d0.md): - [TrackingAdditionalEntitiesResponse](https://developers.polestarglobal.com/trackingadditionalentitiesresponse-17755007d0.md): - [TrackingAdditionalEntityInput](https://developers.polestarglobal.com/trackingadditionalentityinput-17755008d0.md): - [TrackingAdditionalEntitiesPutBody](https://developers.polestarglobal.com/trackingadditionalentitiesputbody-17755009d0.md): - [TrackingAdditionalEntitiesPutResponse](https://developers.polestarglobal.com/trackingadditionalentitiesputresponse-17755010d0.md): - [TrackingAdditionalEntitiesDeleteBody](https://developers.polestarglobal.com/trackingadditionalentitiesdeletebody-17755011d0.md): - [RemovedAdditionalEntity](https://developers.polestarglobal.com/removedadditionalentity-17755012d0.md): - [TrackingAdditionalEntitiesDeleteResponse](https://developers.polestarglobal.com/trackingadditionalentitiesdeleteresponse-17755013d0.md): - [TrackingAdditionalEntityError](https://developers.polestarglobal.com/trackingadditionalentityerror-17755014d0.md): - [FeatureDisabledError](https://developers.polestarglobal.com/featuredisablederror-17755015d0.md): - [ObjectNotFoundError](https://developers.polestarglobal.com/objectnotfounderror-17755016d0.md): - [TransactionValidationError](https://developers.polestarglobal.com/transactionvalidationerror-17755017d0.md): - [VoyageUpdateRequest](https://developers.polestarglobal.com/voyageupdaterequest-17755018d0.md): - [VoyageUpdateResponse](https://developers.polestarglobal.com/voyageupdateresponse-17755019d0.md): - [PTracMeta](https://developers.polestarglobal.com/ptracmeta-17755020d0.md): - [PTracVessel](https://developers.polestarglobal.com/ptracvessel-17755021d0.md): - [PTracVesselSearchResponse](https://developers.polestarglobal.com/ptracvesselsearchresponse-17755022d0.md): - [DuplicateTransactionError](https://developers.polestarglobal.com/duplicatetransactionerror-17755023d0.md): - [DetailMeta](https://developers.polestarglobal.com/detailmeta-17814383d0.md): - [ListMeta](https://developers.polestarglobal.com/listmeta-17814384d0.md): - [ErrorResponse](https://developers.polestarglobal.com/errorresponse-17814385d0.md): - [VesselDetail](https://developers.polestarglobal.com/vesseldetail-17814386d0.md): - [VesselScores](https://developers.polestarglobal.com/vesselscores-17814387d0.md): - [VesselOverallScore](https://developers.polestarglobal.com/vesseloverallscore-17814388d0.md): - [VesselBatchItem](https://developers.polestarglobal.com/vesselbatchitem-17814389d0.md): - [BatchScoresRequest](https://developers.polestarglobal.com/batchscoresrequest-17814390d0.md): - [BatchMeta](https://developers.polestarglobal.com/batchmeta-17814391d0.md): - [GlueExtractResponseBody](https://developers.polestarglobal.com/glueextractresponsebody-17834692d0.md): - [TimelineInfoAllResponseBody](https://developers.polestarglobal.com/timelineinfoallresponsebody-17834693d0.md): - [TimelineInfoByIMOResponseBody](https://developers.polestarglobal.com/timelineinfobyimoresponsebody-17834694d0.md): - [GridCsvRequestBody](https://developers.polestarglobal.com/gridcsvrequestbody-18314745d0.md): - [CoordinateSchema](https://developers.polestarglobal.com/coordinateschema-17834695d0.md): - [DataAtAPointRequestBody](https://developers.polestarglobal.com/dataatapointrequestbody-17834696d0.md): - [DataAtAPointResponseBody](https://developers.polestarglobal.com/dataatapointresponsebody-17834697d0.md): - [GetWeatherParamsResponseBody](https://developers.polestarglobal.com/getweatherparamsresponsebody-17834698d0.md): - [ParamValueSchema](https://developers.polestarglobal.com/paramvalueschema-17834699d0.md): - [PositionSchema](https://developers.polestarglobal.com/positionschema-17834700d0.md): - [WeatherParams](https://developers.polestarglobal.com/weatherparams-17834701d0.md):