/omio/routes

POST /api/omio/routes

Price: 20 credits

Get an overview of an Omio route (mode, origin and destination city): the departure and arrival places (name, country and city codes, Omio position ids), total distance and duration, cheapest price and mode, all available modes and operating providers, the aggregate traveller rating and offer count, a per-mode comparison (train vs bus vs flight: cheapest and average price, duration, CO2 range, directness, popularity and speed flags) and a provider breakdown with per-provider cheapest price, frequency and detail page links. Origin and destination are city slugs as used in Omio route URLs.

How to use it

Get an Omio route overview (mode, origin and destination city slugs). Returns departure/arrival names, country and city codes, position ids, distance_km, duration_minutes, cheapest_price, cheapest_mode, available_modes, provider_names/codes, rating and rating_count, mode_comparison (per-mode price, duration, CO2, flags) and providers (per-provider cheapest_price, frequency, clickouts, page_link for the companies endpoint).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• mode string required — Travel mode (one of: "train", "bus", "flight", "ferry"; examples: "train")
• origin string required — Origin city slug as used in the Omio route URL (examples: "barcelona"; minLength: 1)
• destination string required — Destination city slug as used in the Omio route URL (examples: "madrid"; minLength: 1)

Response

• @type string (default: "OmioRoute")
• departure_id integer nullable
• arrival_id integer nullable
• departure_name string nullable
• arrival_name string nullable
• departure_country_code string nullable
• arrival_country_code string nullable
• departure_city_code string nullable
• arrival_city_code string nullable
• travel_mode string nullable
• distance_km integer nullable
• duration_minutes integer nullable
• cheapest_price number nullable
• cheapest_mode string nullable
• available_modes array (default: [])
• provider_names array (default: [])
• provider_codes array (default: [])
• rating number nullable
• rating_count integer nullable
• offer_count integer nullable
• low_price number nullable
• mode_comparison array (default: [])
  • @type string (default: "OmioModeComparison")
  • mode string nullable
  • cheapest_price number nullable
  • average_price number nullable
  • duration_minutes integer nullable
  • direct boolean nullable
  • clickouts integer nullable
  • co2_min number nullable
  • co2_max number nullable
  • is_cheapest boolean nullable
  • is_fastest boolean nullable
  • is_most_popular boolean nullable
  • is_most_expensive boolean nullable
  • is_lowest_co2 boolean nullable
  • most_popular_provider_code string nullable
  • most_popular_provider_name string nullable
• providers array (default: [])
  • @type string (default: "OmioRouteProvider")
  • code string nullable
  • name string nullable
  • legacy_id integer nullable
  • cheapest_price number nullable
  • duration_minutes integer nullable
  • frequency integer nullable
  • clickouts integer nullable
  • image string nullable
  • page_link 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 — No route found for the given mode, origin and destination 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.