/msc/schedules/search

POST /api/msc/schedules/search

Price: 10 credits

Search MSC point-to-point sailings between two ports by UN/LOCODE from a departure date: vessel, voyage, departure and arrival, transit time, cut-offs and every leg with its port calls.

How to use it

Returns every sailing MSC offers between the two ports from `from_date`; the horizon is set by MSC. Transhipment routes list each vessel change as a separate leg.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• from_port_un_locode string required — UN/LOCODE of the origin port (examples: "NLRTM")
• to_port_un_locode string required — UN/LOCODE of the destination port (examples: "USNYC")
• from_date string required — Earliest departure date, YYYY-MM-DD (format: date; examples: "2026-09-14")

Response

• @type string (default: "MscSailing")
• route_header_id integer nullable
• loading_service_name string nullable
• routing_type string nullable
• is_direct_route boolean nullable
• port_of_load_name string nullable
• port_of_load_un_locode string nullable
• port_of_discharge_name string nullable
• port_of_discharge_un_locode string nullable
• vessel_name string nullable
• departure_voyage_number string nullable
• departure_at string nullable
• arrival_at string nullable
• arrival_at_port_of_load string nullable
• transit_time_hours integer nullable
• co2_footprint string nullable
• cut_offs object nullable
  • @type string (default: "MscCutOffs")
  • container_yard string nullable
  • reefer string nullable
  • dangerous_cargo string nullable
  • shipping_instructions string nullable
  • verified_gross_mass string nullable
• legs array (default: [])
  • @type string (default: "MscRouteLeg")
  • sequence integer nullable
  • is_last_leg boolean nullable
  • is_single_leg boolean nullable
  • service_name string nullable
  • departure_voyage_number string nullable
  • departure_port_name string nullable
  • departure_port_un_locode string nullable
  • departure_port_msc_id integer nullable
  • departure_terminal_name string nullable
  • departure_at string nullable
  • arrival_port_name string nullable
  • arrival_port_un_locode string nullable
  • arrival_port_msc_id integer nullable
  • arrival_terminal_name string nullable
  • arrival_at string nullable
  • co2_footprint string nullable
  • vessel object nullable
    • @type string (default: "MscVessel")
    • name string nullable
    • imo string nullable
    • built_year integer nullable
    • flag_name string nullable
  • port_calls array (default: [])
    • @type string (default: "MscLegPortCall")
    • port_name string nullable
    • port_un_locode string nullable
    • arrival_date string nullable
    • arrival_hour string nullable
    • departure_date string nullable
    • departure_hour 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 serves no route between these ports, or a port code is not an MSC 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.