/msc/schedules/port-calls

POST /api/msc/schedules/port-calls

Price: 1 credit

Get MSC vessel arrivals and departures at a port by UN/LOCODE, with vessel, voyage, service, live time and container cut-offs for departures.

How to use it

Returns recent and upcoming MSC calls at one port; `direction` separates arrivals from departures. The date window is set by MSC and cannot be chosen.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• port_un_locode string required — UN/LOCODE of the port (examples: "NLRTM")

Response

• @type string (default: "MscPortCall")
• direction string required (one of: "arrival", "departure")
• port_name string nullable
• port_un_locode string nullable
• time string nullable
• vessel_name string nullable
• vessel_imo string nullable
• vessel_flag_code string nullable
• vessel_built_year integer nullable
• voyage_number string nullable
• service_name string nullable
• cut_offs array (default: [])
  • @type string (default: "MscCutOff")
  • cut_off_type string nullable
  • value 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 — MSC publishes no arrivals or departures for this port 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.