/vesselfinder/vessels

POST /api/vesselfinder/vessels

Price: 5 credits

Get VesselFinder vessel details and live voyage by IMO or MMSI number

How to use it

Get a full VesselFinder vessel record by IMO (7 digits) or MMSI (9 digits) number. Returns identity (IMO, MMSI, name, callsign, ship type, AIS type, flag, year built), particulars (length overall, beam, gross tonnage, deadweight, maximum/design draught), a photo, and the current voyage: destination port (name and LOCODE), estimated time of arrival, course, speed, current draught, navigation status, last port and its departure time, and the timestamp of the latest position report. Also includes vessel name/flag history. Exact live coordinates are not available. Timestamps (eta, position_received_at, last_port_departure_at) are unix seconds.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• vessel string required — Vessel identifier: IMO number (7 digits) or MMSI number (9 digits) (examples: "9803613", "215325000"; minLength: 1)

Response

• @type string (default: "VesselFinderVessel")
• imo integer nullable
• mmsi integer nullable
• name string required
• ship_type string nullable
• ais_type string nullable
• flag string nullable
• flag_code string nullable
• callsign string nullable
• year_built integer nullable
• length_overall number nullable
• beam number nullable
• gross_tonnage integer nullable
• deadweight integer nullable
• draught_max number nullable
• image string nullable
• url string required
• destination string nullable
• destination_locode string nullable
• eta integer nullable
• course number nullable
• speed number nullable
• draught number nullable
• navigation_status string nullable
• position_received_at integer nullable
• last_port string nullable
• last_port_locode string nullable
• last_port_departure_at integer nullable
• history array (default: [])
  • @type string (default: "VesselFinderVesselNameHistory")
  • year string nullable
  • name string nullable
  • flag string nullable
  • flag_code string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Vessel not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.