Search Houses

The Search Houses endpoint provides a list of available houses based on specified criteria. The response includes detailed information about each house, such as the number of occupants, bedrooms, and bathrooms, as well as pricing and images.

If the request does not specify a start date, end date, or the number of adults, children, or pets, the response defaults to a stay for 2 adults, no children, no pets, for a duration of 2 nights. The default start date is set to at least 4 days from today, depending on availability.

Endpoint

URL:
`/bungalow/api/v1/booking/searchHouses`

Method:
`GET`

Authentication:
API Key-based authentication is required. Include your partner ID and API key in the headers.

Response Model

HousesSearchResult

The root response object.

Property	Type	Description
`houseList`	Array[SearchHouseResult]	List of houses that match the search criteria.
`houseCount`	Integer	Total number of houses returned.

SearchHouseResult

Each house’s detailed information.

Property	Type	Description
`houseId`	Integer	Unique identifier for the house.
`name`	String	Name of the house.
`nrPersons`	TranslatedProperty	Maximum number of persons the house can accommodate.
`bedrooms`	TranslatedProperty	Number of bedrooms in the house.
`bathrooms`	TranslatedProperty	Number of bathrooms in the house.
`numberOfPets`	TranslatedProperty	Maximum number of pets allowed.
`numberOfBeds`	TranslatedProperty	Total number of beds available.
`price`	PriceResult	Pricing details for the house.
`descriptionInterior`	String	Description of the house.
`mainPicture`	String	URL of the main picture of the house.
`pictures`	Array[String]	List of URLs for additional images.
`surface`	TranslatedPropertyString	Surface area of the house.

PriceResult

Pricing details.

Property	Type	Description
`startDate`	String	Start date for the pricing period (ISO 8601).
`endDate`	String	End date for the pricing period (ISO 8601).
`fullPrice`	Number	Full price without any discounts.
`discountedPrice`	Number	Discounted price, if applicable.
`cancellationFundPossible`	Boolean	Indicates if cancellation fund is possible.
`cancellationFund`	Number	Cost of the cancellation fund.
`numberOfPersons`	NumberOfPersonsModel	Number of persons details.
`numberOfPets`	Integer	Maximum number of pets allowed.
`voucherAmount`	Number	Amount that can be applied via a voucher.

TranslatedPropertyString

Localized string property details.

Property	Type	Description
`name`	String	Display name of the property.
`value`	String	Value of the property.

NumberOfPersonsModel

Breakdown of person counts.

Property	Type	Description
`total`	Integer	Total number of persons (calculated).
`child0002`	Integer	Number of children aged 0–2 years.
`child0304`	Integer	Number of children aged 3–4 years.
`child0512`	Integer	Number of children aged 5–12 years.
`child1317`	Integer	Number of children aged 13–17 years.
`adults`	Integer	Number of adults.

Example Request

curl -X GET "https://bungalow/api/v1/booking/searchHouses" \
     -H "x-security-key: <YOUR_API_KEY> x-partner: <YOUR_PARTNER_ID>"

Example Response

{
  "houseList": [
    {
      "houseId": 123,
      "name": "Seaside Villa",
      "nrPersons": {
        "name": "Number of Persons",
        "value": 6
      },
      "bedrooms": {
        "name": "Bedrooms",
        "value": 3
      },
      "bathrooms": {
        "name": "Bathrooms",
        "value": 2
      },
      "numberOfPets": {
        "name": "Pets Allowed",
        "value": 2
      },
      "numberOfBeds": {
        "name": "Beds",
        "value": 5
      },
      "price": {
        "startDate": "2024-12-01",
        "endDate": "2024-12-07",
        "fullPrice": 1000,
        "discountedPrice": 900,
        "cancellationFundPossible": true,
        "cancellationFund": 50,
        "numberOfPersons": {
          "total": 6,
          "adults": 4,
          "child0512": 2
        },
        "voucherAmount": 50
      },
      "descriptionInterior": "A spacious villa with modern amenities.",
      "mainPicture": "https://example.com/images/villa123.jpg",
      "pictures": [
        "https://example.com/images/villa123-1.jpg",
        "https://example.com/images/villa123-2.jpg"
      ],
      "surface": {
        "name": "Surface",
        "value": "150 m²"
      }
    }
  ],
  "houseCount": 1
}

Notes

Ensure the query parameters match the requirements of your use case.
Validate the houseCount to confirm whether results were returned.