/agoda/hotels/search

POST /api/agoda/hotels/search

Price: 1 credit

Search Agoda hotels in a city by numeric city id. Returns a paginated list of properties with id, name, property type, star rating, location (area, city, country with ids), average nightly price, hotel page URL, guest review score with category subscores, facility highlights and photos.

How to use it

Search hotels in an Agoda city by numeric city_id. Returns items with id, name, property_type, accommodation_type, star_rating, area, area_id, city, city_id, country, country_id, average_price, url, review_score (score, review_count, grades with category scores), facility_highlights and images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city_id integer required — Agoda numeric city id to search hotels in (examples: 9395; min: 1)
• count integer required — Max number of hotels to return (min: 1)

Response

• @type string (default: "AgodaSearchHotel")
• id string required
• name string nullable
• property_type string nullable
• accommodation_type string nullable
• star_rating number nullable
• area string nullable
• area_id integer nullable
• city string nullable
• city_id integer nullable
• country string nullable
• country_id integer nullable
• average_price number nullable
• url string nullable
• review_score object nullable
  • @type string (default: "AgodaSearchReviewScore")
  • score number nullable
  • review_count integer nullable
  • grades array (default: [])
    • @type string (default: "AgodaSearchReviewGrade")
    • name string required
    • score number nullable
• facility_highlights array (default: [])
• images array (default: [])

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 — City not found or no hotels available for the given city id 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.