Rentals.ca Filter Options API lists every value the search route accepts for property type, category, lease term, furnished, pets, parking type, sort, region and amenity (148 amenity ids). The sample shows the first entries of long lists. Failed requests are not billed.
Run this endpoint
Endpoint
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"pets": [
{
"id": "all",
"label": "All pets allowed"
},
{
"id": "none",
"label": "No pets"
}
],
"sorts": [
{
"id": "relevant"
},
{
"id": "recent"
},
{
"id": "cheapest"
},
{
"id": "expensive"
},
{
"id": "newest"
},
{
"id": "ranked"
}
],
"regions": [
"AB",
"BC",
"MB",
"NB",
"NL",
"NS",
"NT",
"NU",
"ON",
"PE",
"QC",
"SK",
"YT"
],
"amenities": [
{
"id": "building-features:24h-security",
"key": "24h-security",
"group": "building-features"
},
{
"id": "building-features:bbq-area-courtyard",
"key": "bbq-area-courtyard",
"group": "building-features"
},
{
"id": "building-features:bike-racks",
"key": "bike-racks",
"group": "building-features"
}
],
"furnished": [
{
"id": "fully",
"label": "Fully furnished"
},
{
"id": "partially",
"label": "Partially furnished"
},
{
"id": "no",
"label": "Unfurnished"
},
{
"id": "yes",
"label": "Furnished"
},
{
"id": "mixed",
"label": "Mixed"
}
],
"categories": [
{
"id": "cheap_rentals",
"label": "Cheap rentals"
},
{
"id": "co_op_housing",
"label": "Co-op housing"
},
{
"id": "corporate_housing",
"label": "Corporate housing"
},
{
"id": "luxury_rentals",
"label": "Luxury rentals"
},
{
"id": "senior_housing",
"label": "Senior housing"
},
{
"id": "student_housing",
"label": "Student housing"
},
{
"id": "family_housing",
"label": "Family housing"
},
{
"id": "veteran_housing",
"label": "Veteran housing"
},
{
"id": "sublet",
"label": "Sublet"
},
{
"id": "vacation",
"label": "Vacation"
}
],
"lease_terms": [
{
"id": "short",
"label": "Short term"
},
{
"id": "long",
"label": "Long term"
},
{
"id": "no_long",
"label": "No long term"
},
{
"id": "no_short",
"label": "No short term"
}
],
"parking_types": [
{
"id": "no_parking",
"label": "No parking"
},
{
"id": "garage",
"label": "Garage"
},
{
"id": "driveway",
"label": "Driveway"
},
{
"id": "underground",
"label": "Underground"
},
{
"id": "street",
"label": "Street"
},
{
"id": "visitor",
"label": "Visitor"
},
{
"id": "outdoor",
"label": "Outdoor"
},
{
"id": "indoor",
"label": "Indoor"
},
{
"id": "covered",
"label": "Covered"
},
{
"id": "electric",
"label": "Electric vehicle charging"
},
{
"id": "valet",
"label": "Valet"
}
],
"property_types": [
{
"id": "condo",
"label": "Condo"
},
{
"id": "condo_community",
"label": "Condo community"
},
{
"id": "apartment",
"label": "Apartment"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "facets"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Upstream Unavailable
Rentals.ca could not be reached or returned data that does not match the request. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "facets"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Rentals.ca could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.