# Rentals.ca Search API Documentation

Rentals.ca Search API searches Canadian rentals by city or province. Each listing is a building with its floor plans. Rent, bedroom, bathroom and size filters are checked on every floor plan, so a unit that breaks a filter is never returned and a building with no fitting unit is left out. A page can therefore hold fewer than per_page listings. Rentals only: there is no sale mode and no keyword search, and both are rejected. Rents that are placeholders (for example a call-for-price entry) are returned as null. Hidden street addresses are returned without street and postal code. Searching by neighbourhood is not supported. A page past the end returns an empty list. If a city name does not match a known place the site answers with zero results, so a warning is returned: check the spelling with the autocomplete or cities route. Failed requests are not billed.

- **Documentation:** [https://scrappa.co/docs/rentals-ca-api/rentals_ca_search](https://scrappa.co/docs/rentals-ca-api/rentals_ca_search) - **API group:** Rentals.ca API - **Endpoint:** `GET https://scrappa.co/api/rentals-ca/search` ## Authentication Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key. ## Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `city` | string | No | City name, used with region. Example: Toronto. | | `region` | string | No | Province or territory code: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK or YT. Alone, it searches the whole province. | | `location` | string | No | Ready location value from the autocomplete route, such as toronto, on, ca. Use it instead of city and region. | | `min_price` | integer | No | Minimum monthly rent in CAD. | | `max_price` | integer | No | Maximum monthly rent in CAD. | | `min_beds` | integer | No | Minimum bedrooms. 0 is a studio. | | `max_beds` | integer | No | Maximum bedrooms. | | `min_baths` | number | No | Minimum bathrooms, for example 1.5. | | `max_baths` | number | No | Maximum bathrooms. | | `min_size` | integer | No | Minimum size in square feet. | | `max_size` | integer | No | Maximum size in square feet. | | `property_type` | array | No | Comma separated property types, for example condo,apartment,house. See the filter options route. | | `categories` | array | No | Comma separated categories such as student_housing or luxury_rentals. | | `lease_terms` | array | No | Comma separated lease terms: short, long, no_long or no_short. | | `furnished` | array | No | Comma separated: fully, partially, no, yes or mixed. | | `parking_types` | array | No | Comma separated parking types such as underground or garage. | | `amenities` | array | No | Comma separated amenity ids such as building-features:concierge. See the filter options route. | | `pets` | string | No | all (all pets allowed) or none (no pets). | | `verified` | boolean | No | true returns verified listings only. | | `has_images` | boolean | No | true returns listings with photos only. | | `sort` | string | No | relevant (default), recent, cheapest, expensive, newest or ranked. | | `page` | integer | No | One-based page number, 1 to 100 (default 1). | | `per_page` | integer | No | Listings per page, 1 to 100 (default 20). | ## Example response ```json { "data": { "page": 1, "total": 1162, "warning": null, "listings": [ { "id": "cmVudGFsbGlzdGluZzozNzIyMzU=", "url": "https://rentals.ca/toronto/730-st-clarens-avenue-1", "beds": { "max": 2, "min": 2 }, "name": "730 St. Clarens", "path": "toronto/730-st-clarens-avenue-1", "pets": [ "all" ], "rent": { "max": 2375, "min": 2300 }, "size": { "max": 640, "min": 640 }, "type": "apartment", "baths": { "max": 1, "min": 1 }, "address": { "city": "Toronto", "region": "ON", "street": "730 St Clarens Avenue", "city_path": "toronto", "postal_code": "M6H 4E8", "neighbourhood": null, "address_hidden": false, "neighbourhood_path": null }, "created": "2020-09-09T20:51:41+00:00", "latitude": 43.667254, "modified": "2026-10-23T17:47:39+00:00", "verified": true, "longitude": -79.445707, "thumbnail": { "large": "https://images.rentals.ca/property-pictures/large/toronto-on/372235/apartment-2240761769.jpg", "small": "https://images.rentals.ca/property-pictures/small/toronto-on/372235/apartment-2240761769.jpg", "medium": "https://images.rentals.ca/property-pictures/medium/toronto-on/372235/apartment-2240761769.jpg", "caption": "kitchen" }, "floor_plans": [ { "beds": 2, "rent": 2300, "size": 640, "baths": 1, "available_now": true, "available_from": null }, { "beds": 2, "rent": 2375, "size": 640, "baths": 1, "available_now": true, "available_from": null } ], "images_count": 45, "listing_type": "residential:apartment:apartment" } ], "per_page": 20, "next_page": 2, "has_next_page": true, "filtered_count": 1, "search_metadata": { "status": "Success", "total_floor_plans": 1937 }, "search_parameters": { "sort": "cheapest", "place": "toronto, on, ca", "filters": { "max_beds": 2, "min_beds": 2, "max_price": 2500, "min_price": 1500 } } }, "meta": { "billable": true, "endpoint_family": "search" }, "success": true } ``` ## Errors | Status | Error | Description | | --- | --- | --- | | 422 | Validation Error | A required parameter, a range or a value is invalid. This response is not billable. | | 503 | 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. | ## More Scrappa resources - [API documentation](https://scrappa.co/docs) - [Full LLM-readable API reference](https://scrappa.co/llms-full.txt) - [OpenAPI specification](https://scrappa.co/docs/api.json) - [Pricing](https://scrappa.co/pricing)