# RentFaster Filters API Documentation

<p><strong>RentFaster Filters API</strong> returns the city record, every community and the filter vocabulary for one city: property types, bedrooms, bathrooms, furnishing, cat and dog policy, smoking, lease terms, parking, home features, community features, building features and utilities. Use these values in the search filters. An unknown city id returns a non-billable 404.</p>

- **Documentation:** [https://scrappa.co/docs/rentfaster-api/rentfaster_filters](https://scrappa.co/docs/rentfaster-api/rentfaster_filters)
- **API group:** RentFaster API
- **Endpoint:** `GET https://scrappa.co/api/rentfaster/filters`

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

## Example response

```json
{
    "data": {
        "city": {
            "id": 1,
            "name": "Calgary",
            "slug": "calgary",
            "is_major": true,
            "latitude": 51.045833,
            "province": "Alberta",
            "longitude": -114.0575,
            "quadrants": [
                "NW",
                "NE",
                "SW",
                "SE",
                "Inner-City"
            ],
            "description_text": "The rental landscape in Calgary offers a wealth of opportunities with 7,993 properties available for rent. These residences vary from 1 to 4 bedrooms, with 2-be\u2026"
        },
        "vocabulary": {
            "beds": [
                "bachelor",
                "1",
                "1 + Den",
                "2"
            ],
            "type": [
                "Apartment",
                "Condo Unit",
                "Loft",
                "House"
            ],
            "baths": [
                "none",
                "1",
                "1.5",
                "2"
            ],
            "parking": [
                "no parking",
                "outdoor",
                "indoor",
                "street"
            ],
            "smoking": [
                "Non-Smoking",
                "Smoking Allowed",
                "Negotiable"
            ],
            "pets_cats": [
                "Not Allowed",
                "Negotiable"
            ],
            "pets_dogs": [
                "Not Allowed",
                "Negotiable"
            ],
            "furnishing": [
                "Unfurnished",
                "Semi-Furnished",
                "Furnished",
                "Negotiable"
            ],
            "lease_term": [
                "Short Term",
                "Long Term",
                "Negotiable"
            ],
            "home_features": [
                "Rent-to-Own",
                "Corner Unit",
                "Penthouse Unit",
                "Laundry - In Suite"
            ],
            "building_features": [
                "Concierge",
                "On-Site Management",
                "Elevator",
                "Walk-Up"
            ],
            "community_features": [
                "Lake",
                "River",
                "Golf Course",
                "Pool"
            ],
            "utilities_included": [
                "Heat",
                "Electricity",
                "Water",
                "Cable"
            ]
        },
        "communities": [
            {
                "id": 1,
                "name": "Abbeydale"
            },
            {
                "id": 1729,
                "name": "Academy"
            },
            {
                "id": 2,
                "name": "Acadia"
            }
        ]
    },
    "meta": {
        "billable": true,
        "duration_ms": 900,
        "endpoint_family": "filters"
    },
    "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. 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)