/vesselfinder/ports

POST /api/vesselfinder/ports

Price: 5 credits

Get a VesselFinder port by LOCODE with live traffic (expected, arrivals, departures, in port)

How to use it

Get a VesselFinder port by its UN/LOCODE. Returns the port name, country, coordinates, local time and traffic counters (vessels arrived in the past 24 hours, ships expected in the next 30 days), plus four movement lists: expected arrivals, recent arrivals, recent departures and ships currently in port. Each movement carries the reported time, ship type, flag, year built, gross tonnage, deadweight and dimensions. Movement lists are capped at the publicly available depth.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• locode string required — UN/LOCODE of the port as used by VesselFinder (e.g. 'GBABD001') (examples: "GBABD001", "NLRTM001"; minLength: 1)

Response

• @type string (default: "VesselFinderPort")
• locode string required
• name string required
• country string nullable
• country_code string nullable
• latitude number nullable
• longitude number nullable
• local_time string nullable
• arrived_24h_count integer nullable
• expected_30d_count integer nullable
• url string required
• expected array (default: [])
  • @type string (default: "VesselFinderPortMovement")
  • time string nullable
  • ship_type string nullable
  • flag string nullable
  • flag_code string nullable
  • year_built integer nullable
  • gross_tonnage integer nullable
  • deadweight integer nullable
  • length_overall number nullable
  • beam number nullable
• arrivals array (default: [])
  • @type string (default: "VesselFinderPortMovement")
  • time string nullable
  • ship_type string nullable
  • flag string nullable
  • flag_code string nullable
  • year_built integer nullable
  • gross_tonnage integer nullable
  • deadweight integer nullable
  • length_overall number nullable
  • beam number nullable
• departures array (default: [])
  • @type string (default: "VesselFinderPortMovement")
  • time string nullable
  • ship_type string nullable
  • flag string nullable
  • flag_code string nullable
  • year_built integer nullable
  • gross_tonnage integer nullable
  • deadweight integer nullable
  • length_overall number nullable
  • beam number nullable
• in_port array (default: [])
  • @type string (default: "VesselFinderPortMovement")
  • time string nullable
  • ship_type string nullable
  • flag string nullable
  • flag_code string nullable
  • year_built integer nullable
  • gross_tonnage integer nullable
  • deadweight integer nullable
  • length_overall number nullable
  • beam number 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 — Port 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.