# Rentals.ca Filter Options API Documentation

<p><strong>Rentals.ca Filter Options API</strong> 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.</p>

- **Documentation:** [https://scrappa.co/docs/rentals-ca-api/rentals_ca_facets](https://scrappa.co/docs/rentals-ca-api/rentals_ca_facets)
- **API group:** Rentals.ca API
- **Endpoint:** `GET https://scrappa.co/api/rentals-ca/facets`

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

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 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)