Agoda

Search Agoda Homes & Apartments by city

Returns Homes & Apartments results for an Agoda city: full listing detail for every matching property whose accommodation type is Apartment. Callers may supply a known Agoda city id or a free-text city name; when both are supplied city_id takes precedence.

get/agoda/homes/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/agoda/homes/search
  • Auth: API key in header x-api-key

Query parameters

city_idinteger

Numeric Agoda city id, e.g. 9395 for Bangkok. Either city_id or city is required; city_id takes precedence when both are supplied.

citystring

Free-text city name, resolved to a numeric city id via Agoda's own destination search. Ignored when city_id is also supplied.

pageinteger

1-indexed result page over the underlying city search, defaults to 1

limitinteger

Candidate listings fetched per page before filtering to homes/apartments, defaults to 10, maximum 50

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "city_id": 9395,
    "count": 1,
    "homes": [
      {
        "accommodation_type": 34,
        "address": {
          "address1": "222 Ratchaprarop Road, Ratchathewi",
          "city": {
            "id": 9395,
            "name": "Bangkok"
          },
          "country": {
            "id": 106,
            "name": "Thailand"
          },
          "postal_code": "10400"
        },
        "chain_id": 3603,
        "children_stay_free_type_id": 1,
        "description_short": "Experience Luxury and Convenience at Baiyoke Sky Hotel.",
        "display_name": "Baiyoke Sky Hotel",
        "main_image_url": "https://pix8.agoda.net/hotelImages/10637/-1/878a9b58ccd19eee41b98d20e388c080.jpg?ca=9&ce=1",
        "number_of_rooms": "659",
        "policy": {
          "additional": [
            "When booking more than 5 rooms",
            " different policies and additional supplements may apply."
          ],
          "adult": [
            "Guests 12 years and older are considered adults."
          ],
          "extra_bed": [
            "Extra beds are dependent on the room you choose. Please check the individual room capacity for more details."
          ]
        },
        "property_id": 10637,
        "rating": 4,
        "source_url": "https://www.agoda.com/search?cid=-1&selectedproperty=10637&city=9395"
      }
    ],
    "limit": 10,
    "page": 1
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.