/omio/positions/search

POST /api/omio/positions/search

Price: 5 credits

Resolve a city, station, airport or port name into Omio places via autocomplete. Returns ranked matches with the position id, display name, place type (location, station, airport, busstation or ferry terminal), parent city, country, coordinates, timezone, IATA code (airports), station counts and, for cities, the child stations grouped underneath. Use this to discover the place names that drive the journeys, prices and route endpoints, plus external ids (Wikidata, OSM, Google Place) for each place.

How to use it

Autocomplete Omio places by keyword (a city, station, airport or port name). Returns matches with id, name, type, city, country, country_code, latitude/longitude, timezone, iata_code, canonical_name, station counts and children (stations under a city). Use the returned city name as origin/destination in the journeys, prices, routes and reviews endpoints.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — City, station, airport or port name to search for (examples: "munich"; minLength: 1)
• locale string — Language code for localized place names (default: "en"; examples: "en", "de")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "OmioPosition")
• id integer nullable
• name string nullable
• type string nullable
• city string nullable
• country string nullable
• country_code string nullable
• latitude number nullable
• longitude number nullable
• timezone string nullable
• population integer nullable
• iata_code string nullable
• canonical_name string nullable
• in_europe boolean nullable
• train_station_count integer nullable
• bus_station_count integer nullable
• airport_count integer nullable
• ferry_terminal_count integer nullable
• osm_node_id string nullable
• wikidata_id string nullable
• wikipedia_id string nullable
• google_place_id string nullable
• children array (default: [])

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 places matched the given keyword 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.