/yatra/hotels/search

POST /api/yatra/hotels/search

Price: 20 credits

Search Yatra hotels in a city for given dates and guests: name, stars, guest rating, locality and coordinates, photos, amenities, nearby landmarks, total price of the stay before and after discount with tax, per-night price, promo code, room and rate plan, with star, guest rating, price band, property type, chain, locality and feature filters

How to use it

Get the city name from yatra/places/search. Pass a returned id and city to yatra/hotels for the full description, rooms and reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City name (examples: "Goa", "Manali"; minLength: 2)
• check_in integer required — Check-in date, unix seconds (examples: 1795113000; min: 0)
• check_out integer required — Check-out date, unix seconds (examples: 1795199400; min: 0)
• adults integer — Adult guests (default: 2; min: 1; max: 8)
• children integer — Child guests (default: 0; min: 0; max: 4)
• star_ratings array — Hotel star classes to keep (default: []; examples: [4,5])
• guest_ratings array — Guest rating bands to keep (default: []; examples: [4,5])
• price_ranges array — Nightly price bands in INR to keep (default: []; one of: "below_1000", "1001_2000", "2001_4000", "4001_7000", "7001_10000", "above_10000")
• property_types array — Property types to keep (default: []; examples: ["Resort","Villa"])
• chains array — Hotel chains to keep (default: []; examples: ["Treebo Hotels"])
• localities array — Localities to keep (default: []; examples: ["Calangute"])
• features array — Stay features to keep (default: []; examples: ["Free Cancellation","Free Breakfast"])
• sort string — Result order (default: "relevance"; one of: "relevance", "price_low", "price_high")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "YatraHotelCard")
• id string required
• name string nullable
• alias string nullable
• property_type string nullable
• categories array (default: [])
• star_rating number nullable
• chain string nullable
• city string nullable
• area string nullable
• sub_area string nullable
• zone string nullable
• area_zone string nullable
• latitude number nullable
• longitude number nullable
• rooms_count integer nullable
• rank integer nullable
• guest_rating number nullable
• review_count integer nullable
• image string nullable
• images array (default: [])
• themes array (default: [])
• amenities array (default: [])
• landmarks array (default: [])
  • @type string (default: "YatraLandmark")
  • name string required
  • distance_km number nullable
• is_yatra_smart boolean (default: false)
• couple_friendly boolean (default: false)
• pet_friendly boolean (default: false)
• women_friendly boolean (default: false)
• eco_plus boolean (default: false)
• long_stay boolean (default: false)
• currency string nullable
• price number nullable
• discounted_price number nullable
• base_price number nullable
• tax number nullable
• per_night_price number nullable
• per_night_discounted_price number nullable
• total_discount number nullable
• savings_percent number nullable
• promo_code string nullable
• promo_discount number nullable
• free_cancellation boolean nullable
• pay_later boolean nullable
• rooms_left integer nullable
• room_name string nullable
• rate_plan_name string nullable
• max_guests integer nullable
• inclusions array (default: [])
• highlights array (default: [])
• supplier 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.