Port calls of one MMSI over a time range
Ordered by arrival (by departure with event=departure). A private vessel without access returns an empty page, like a vessel without port calls.
Request
- Base URL: https://api.aistrail.com
- URL: https://api.aistrail.com/v1/vessels/{mmsi}/port-calls
- Auth: HTTP bearer
Path parameters
Query parameters
ISO 8601 start; default: to minus 30 days
ISO 8601 end (exclusive); default: now on plans with live data, otherwise now minus 24 h. Later values are clamped (see meta.embargo_cutoff). One query may span at most 366 days
any = calls in port at any time in the range (default); arrival = calls that arrived in the range; departure = calls that departed in the range
json, csv (text/csv) or xlsx (Excel workbook); csv and xlsx page through the Link / X-Next-Cursor headers
port = port calls (default); anchorage = waits at the port's anchorage: a stop of at least 1 hour just outside the port area (up to 12 km beyond it); all = both, in one order
calls = one row per port call (default); events = one ENTER_ZONE row at arrival and, once the vessel has left, one EXIT_ZONE row at departure, with the draught reported then (json: events instead of port_calls). Paging and credits stay per port call
Port calls per page, up to 10000 or the plan's rows per page when that is lower; default 1000
Opaque cursor from meta.next_cursor. When given, from, to, event and the filters are taken from the cursor
Response
Port calls
Changes
No recorded changes to this operation across all 2 revisions of this API.