/getyourguide/locations

POST /api/getyourguide/locations

Price: 1 credit

Get a GetYourGuide location (destination, city, region, country, or point of interest) by id or location URL: name, location type, parent city, region and country, page title and description, hero image, number of available activities, and the activity categories offered there (boat cruises, museums, walking tours, food & drink, and more).

How to use it

Fetch a single GetYourGuide location by id (e.g. 16 or l16) or a location URL. Returns one item with id, name, alias (slug), type (city, poi, region, country), url, title, description, image, country and country_id, region and region_id, city and city_id, activity_count (number of activities available), and categories (id + name of the activity categories offered at this location).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — GetYourGuide location id (e.g. 16 or l16) or a location page URL containing it (examples: "16", "https://www.getyourguide.com/paris-l16/"; minLength: 1)

Response

• @type string (default: "GetYourGuideLocation")
• id integer required
• name string required
• alias string nullable
• type string nullable
• url string required
• description string nullable
• image string nullable
• country string nullable
• country_id integer nullable
• region string nullable
• region_id integer nullable
• city string nullable
• city_id integer nullable
• activity_count integer nullable
• categories array (default: [])
  • @type string (default: "GetYourGuideLocationCategory")
  • id string nullable
  • name string required

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 — Location not found (well-formed but nonexistent location id, or page has no location) 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.