RentFaster Filters API 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.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
integer
Required
City id from the autocomplete endpoint, e.g. 1 for Calgary or 2 for Edmonton.
1234567890
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A public parameter is missing or invalid. This response is not billable.
{
"errors": {
"city_id": [
"The city id field is required."
]
},
"message": "The request validation failed"
}Not Found
RentFaster has no such city id. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"duration_ms": 700,
"endpoint_family": "filters"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested RentFaster resource was not found."
},
"success": false
}Service Unavailable
RentFaster is temporarily unavailable. This response is not billable and can be retried.
{
"meta": {
"billable": false,
"retryable": true,
"duration_ms": 4200,
"endpoint_family": "filters"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "RentFaster is temporarily unavailable. Please retry."
},
"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.