/skyscanner/places/search

POST /api/skyscanner/places/search

Price: 1 credit

Resolve a place name, city or airport into Skyscanner place identifiers via autosuggest. Returns ranked matches with the entity id (used as origin/destination in flights search), sky id, IATA code (city metro code, e.g. LON for London), display name, place type (airport, city or country), parent city, country and coordinates. Use this to turn a human place name into the entity ids required by the flights search endpoint.

How to use it

Autosuggest Skyscanner places by query (a city, airport or country name). Returns matches with entity_id (feed this as origin/destination to flights/search), sky_id, iata_code (the city IATA metro code, e.g. LON; null for individual airports), name, type (airport/city/country), city, country, country_code and latitude/longitude.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Place name, city or airport to search for (examples: "london"; minLength: 1)
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "SkyscannerPlaceSuggestion")
• entity_id string nullable
• sky_id string nullable
• iata_code string nullable
• name string nullable
• type string nullable
• city string nullable
• country string nullable
• country_code 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 query 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.