Search available amenities
Search for property amenities by keyword. Returns amenity names and the count of properties that have each amenity. Use the returned amenity names in the `/search-property` endpoint's `amenities` parameter.
Authorization
RapidApiKey X-RapidAPI-Key<token>
In: header
Query Parameters
query*string
- Search query for amenities
- Examples:
swimming,gym,security,parking,sauna - Returns matching amenity names that can be used in
/search-propertyamenitiesparameter
Length
1 <= length <= 200Header Parameters
X-RapidAPI-Host*string
Default
"bayut14.p.rapidapi.com"Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/amenities-search?query=swimming" \ -H "X-RapidAPI-Host: bayut14.p.rapidapi.com"{
"success": true,
"data": {
"amenities": [
{
"value": "Swimming Pool",
"count": 45230,
"highlighted": "<em>Swimming</em> Pool"
}
],
"total": 3
}
}{
"success": false,
"message": "Invalid request: Missing required parameter",
"error": "VALIDATION_ERROR"
}{
"success": false,
"message": "Internal server error. Please try again later.",
"error": "INTERNAL_ERROR"
}{
"success": false,
"message": "Service temporarily unavailable. Please try again later.",
"error": "API_ERROR"
}