VEvesselfinder
Credit methods

ExpectedArrivals

Returns vessels expected to arrive at a port within a time window, given either by interval (minutes ahead) or by fromdate and todate. A vessel is included when the port is entered as Destination in its AIS transponder.

get/expectedarrivals

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 required

UN/LOCODE of the port.

intervalinteger

Minutes into the future to look for arrivals. Required unless fromdate and todate are given.

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.

aistypestring

Comma-separated AIS ship type codes. See AIS Ship Types.

extradata'voyage' | 'master' | 'voyage,master'

Additional datasets, comma-separated.

limitinteger

Maximum number of returned records.

Response

Array of vessel records. Each record has an AIS object, plus VOYAGE and MASTERDATA when those datasets are requested or included in the subscription.

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.