VEvesselfinder
Credit methods

PortCalls

Returns arrival and departure events for a port (locode) or for vessels (imo/mmsi). If locode is given, imo and mmsi are ignored.

Use last_id for incremental polling: only events with an ID greater than the value are returned, and fromdate/todate are ignored.

get/portcalls

Request

  • Base URL
    https://api.vesselfinder.com
  • Auth
    API key in query parameter userkey

Query parameters

format'json' | 'xml'

Response format.

errormode409

Set to 409 to receive errors as HTTP 409 with a plain-text body instead of HTTP 200 with an error object.

locodestring

UN/LOCODE of the port. Required unless imo or mmsi is given.

imostring

Comma-separated IMO numbers. Ignored when locode is given.

mmsistring

Comma-separated MMSI numbers. Ignored when locode is given.

intervalinteger

Maximum age of events, in minutes. Required unless fromdate/todate or last_id is used.

fromdatestring
Example:2017-08-01 00:00:00

Start of the time window, UTC, YYYY-MM-DD HH:MM:SS.

todatestring
Example:2017-08-05 23:59:59

End of the time window, UTC, YYYY-MM-DD HH:MM:SS.

last_idinteger

Return only events with ID greater than this value. Overrides fromdate and todate.

event'arrival' | 'departure'

Filter by event type.

extradata'ais' | 'voyage' | 'ais,voyage'

Additional datasets. voyage is available only for arrivals at a selected port.

anchorage0 | 1 | 2

0 exclude anchorages, 1 include, 2 anchorages only.

imo_only0 | 1

1 returns only vessels that have an IMO number.

limitinteger

Maximum number of returned records.

Response

Port call events.

OR

Example response

[
  {
    "AIS": {
      "MMSI": 304491000,
      "TIMESTAMP": "2017-08-11 11:15:15 UTC",
      "ZONE": "North Sea"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.