/hopper/locations/search

POST /api/hopper/locations/search

Price: 5 credits

Search Hopper locations by keyword. Set kind to flight to resolve cities and airports (with their IATA / city codes) for the flight endpoints, or stay to resolve places and hotels (with their Google place ids) for the hotel endpoints. Returns each match with its label, sub-label, code or place id, and type.

How to use it

Autocomplete Hopper locations. kind=flight returns airports/cities with code (IATA or city code) and location_type (airport/city) — use code for hopper/flights/search. kind=stay returns places/hotels with place_id (Google place id) and place_type — use place_id for hopper/hotels/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Location search term (city, airport or hotel name) (examples: "Las Vegas"; minLength: 1)
• kind string — Which catalogue: flight locations (cities/airports) or stay locations (places/hotels) (default: "stay"; one of: "flight", "stay")
• count integer required — Max number of locations to return (min: 1)

Response

• @type string (default: "HopperLocation")
• label string required
• sub_label string nullable
• kind string required
• place_id string nullable
• place_type string nullable
• code string nullable
• location_type 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 — The entity was not found, or a precondition failed 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.