/despegar/places/search

POST /api/despegar/places/search

Price: 1 credit

Resolve a city, airport, hotel or point of interest name into Despegar geo identifiers. Returns ranked matches with the geo id (e.g. CIT_982 for a city, AIR_192636 for an airport, HOT_335526 for a hotel, POI_531400 for a point of interest), the plain numeric id, place type, city code, airport IATA code, display name, parent country, city and administrative-division ids and coordinates. Use the returned ids as the destination for hotel and activity search. Pick the product the place is resolved for (hotels or activities) to bias which matches surface; the returned geo ids are usable across products.

How to use it

Autocomplete Despegar places by keyword for a region and product. Returns items with id (geo id like CIT_982/AIR_192636/HOT_335526/POI_531400), geo_id (numeric), place_type (CITY/AIRPORT/HOTEL/POI/ZONE/VACATION_RENTAL), code (city metro code, e.g. BUE), iata (airport code), name, country_id, city_id, administrative_division_id (province/state geo id) and latitude/longitude. Feed the city id to hotels/search (destination).

Parameters

access-token string required

Request body

timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
region string — Despegar country site to query. (default: "AR"; one of: "AR", "BO", "CL", "CO", "CR", "EC", "SV", "GT", "MX", "NI", "PA", "PY", "PE", "PR", "US", "UY")
keyword string required — City, airport, hotel or point of interest to search for (minLength: 1)
product string — Travel product the place is resolved for. (default: "hotels"; one of: "hotels", "activities")
count integer required — Max number of places to return (min: 1)

Response

@type string (default: "DespegarPlace")
id string required
geo_id string nullable
place_type string nullable
code string nullable
iata string nullable
name string nullable
country_id string nullable
city_id string nullable
administrative_division_id string nullable
latitude number nullable
longitude number 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 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.