# RentFaster Search API Documentation

<p><strong>RentFaster Search API</strong> returns current Canadian rental listings from RentFaster for one city. Filter by bedrooms, bathrooms, property type, rent range, furnishing, cat and dog policy or a map box, and page through the results (48 per page). Every listing carries the id, URL, title, rent range with parsed minimum and maximum, bedrooms, bathrooms, area in square feet, availability, address, community, coordinates, pets, utilities, features, parking, images and contact details. Filters are always honoured: if RentFaster ignores a filter, the request fails instead of returning unfiltered rows. Page N is the real Nth page. Junk rows such as storage units and one-dollar placeholders are removed and counted in <code>removed_count</code>; <code>total_results</code> is the site total. RentFaster lists rentals only; there are no sale listings. A valid search with no matches is a successful, empty response.</p>

- **Documentation:** [https://scrappa.co/docs/rentfaster-api/rentfaster_search](https://scrappa.co/docs/rentfaster-api/rentfaster_search)
- **API group:** RentFaster API
- **Endpoint:** `GET https://scrappa.co/api/rentfaster/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_id` | integer | Yes | City id from the autocomplete endpoint, e.g. 1 for Calgary or 2 for Edmonton. |
| `beds` | array | No | Bedroom filter, repeat it or send a comma list: bachelor, 1, 1 + Den, 2, 2 + Den, 3 up to 12. |
| `baths` | array | No | Bathroom filter, repeatable: none, 1, 1.5, 2, 2.5 up to 12. |
| `type` | array | No | Property type, repeatable: Apartment, Condo Unit, Loft, House, Townhouse, Room For Rent, Duplex, Triplex, Fourplex, Main Floor, Basement, Garage Suite, Acreage, Office Space, Parking Spot, Vacation Home, Other. |
| `price_min` | integer | No | Minimum monthly rent in CAD. A listing with a rent range matches when the range overlaps. |
| `price_max` | integer | No | Maximum monthly rent in CAD. |
| `furnishing` | array | No | Unfurnished, Semi-Furnished, Furnished or Negotiable. Furnished also returns Negotiable listings. |
| `pets_cats` | array | No | Cat policy: Not Allowed or Negotiable. |
| `pets_dogs` | array | No | Dog policy: Not Allowed or Negotiable. |
| `area` | string | No | Bounding box lat1,lng1,lat2,lng2 inside the city. Requires zoom. |
| `zoom` | integer | No | Map zoom level 1-21. Required with area. |
| `page` | integer | No | One-based page number. Every page has up to 48 listings. |

## Example response

```json
{
    "data": {
        "listings": [
            {
                "id": 608765,
                "den": "No",
                "url": "https://www.rentfaster.ca/properties/2719-17-ave-sw-calgary-608765",
                "city": "Calgary",
                "pets": {
                    "cats": true,
                    "dogs": true
                },
                "intro": "2719 17 Ave SW",
                "price": "1574 - 1900",
                "title": "Discover elevated living at The Wellington | Steps away from popular shops and restaurants on 17th Ave!",
                "images": {
                    "slide": "https://rf-images-prod-bcdn.rentfaster.ca/608765/slide_17643324.v.b60c41aa0169c7b9ed99e26efbf9f48b.jpg",
                    "thumbnail": "https://rf-images-prod-bcdn.rentfaster.ca/608765/thumber_17643324.v.b60c41aa0169c7b9ed99e26efbf9f48b.jpg"
                },
                "ref_id": "608765",
                "status": "active",
                "address": "2719 17 Ave SW",
                "contact": {
                    "phone": "5873176760",
                    "phone_2": null,
                    "website": "https://deltontownhomes.com/?utm_source=RentSync&utm_medium=Rentals.ca%20Infinity%20Network&utm_campaign=The%20Wellington",
                    "email_available": true,
                    "preferred_contact": "Phone||Text||Email"
                },
                "parking": [
                    "outdoor"
                ],
                "smoking": null,
                "agent_id": 405365,
                "bedrooms": "1 - 2",
                "currency": "CAD",
                "features": [
                    "Elevator",
                    "Laundry - Shared",
                    "Fridge",
                    "Oven/Stove"
                ],
                "latitude": 51.037585,
                "province": "Alberta",
                "verified": false,
                "area_sqft": "562, 850",
                "bathrooms": "1",
                "city_slug": "/ab/calgary/",
                "community": "Shaganappi",
                "longitude": -114.12559,
                "price_max": 1900,
                "price_min": 1574,
                "has_studio": false,
                "lease_term": "Long Term",
                "garage_size": null,
                "listed_date": "2025-03-01",
                "availability": "Immediate",
                "bedrooms_max": 2,
                "bedrooms_min": 1,
                "tour_booking": false,
                "area_sqft_max": 850,
                "area_sqft_min": 562,
                "bathrooms_max": 1,
                "bathrooms_min": 1,
                "property_type": "Apartment",
                "province_code": "AB",
                "address_hidden": false,
                "available_date": "Immediate",
                "utilities_included": [
                    "Heat"
                ]
            }
        ],
        "search_metadata": {
            "page": 1,
            "city_id": 1,
            "has_more": true,
            "page_size": 48,
            "removed_count": 1,
            "total_results": 1165,
            "returned_count": 47,
            "applied_filters": {
                "beds": [
                    "2"
                ],
                "price_max": 2500
            }
        }
    },
    "meta": {
        "billable": true,
        "duration_ms": 900,
        "endpoint_family": "search"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A public parameter is missing or invalid. This response is not billable. |
| 404 | Not Found | RentFaster has no such city id (use the autocomplete endpoint). This response is not billable. |
| 503 | Filter Not Applied | RentFaster did not apply a requested filter, so no rows are returned. This response is not billable. |
| 503 | Service Unavailable | RentFaster is temporarily unavailable. This response is not billable and can be retried. |

## 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)
