Credit methods

Vessels

Returns the latest AIS data for one or more vessels, identified by IMO, MMSI or both. Optionally adds Voyage and Master datasets.

get/vessels

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.

imostring

Comma-separated IMO numbers. At least one of imo or mmsi is required.

mmsistring

Comma-separated MMSI numbers. At least one of imo or mmsi is required.

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

Additional datasets, comma-separated.

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.