/omio/journeys/prices

POST /api/omio/journeys/prices

Price: 20 credits

Get the price calendar for an Omio route (mode, origin and destination city): the cheapest fare per travel mode for each upcoming date over roughly three weeks. Each entry gives the date, travel mode, price (EUR), the cheapest departure/arrival times of that day and the operating carrier, including whether it is a high-speed or night train. Prices are returned for every mode available on the route, not only the requested one. Origin and destination are city slugs as used in Omio route URLs.

How to use it

Get the Omio price calendar for a route (mode, origin and destination city slugs): cheapest fare per mode per upcoming date (~3 weeks). Each entry has date, mode, price (EUR), currency, departure_at, arrival_at, carrier_name/code and is_high_speed_train/is_night_train flags. Entries cover all modes available on the route.

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)
• count integer required — Max number of price calendar entries to return (min: 1)

Response

• @type string (default: "OmioPriceCalendarEntry")
• date string nullable
• mode string nullable
• price number nullable
• currency string (default: "EUR")
• departure_at string nullable
• arrival_at string nullable
• carrier_code string nullable
• carrier_name string nullable
• is_high_speed_train boolean nullable
• is_night_train boolean 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 price calendar found for the given route 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.