Subscription methods

LiveData

Returns data for all vessels inside a predefined geographic area. The area, datasets and any filters (type, size) are set by your subscription. The minimum time between requests is set by your subscription. Faster requests return the error Too frequent requests!

get/livedata

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.

intervalinteger

Maximum age of returned positions, in minutes.

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.