RentFaster Autocomplete API suggests cities, communities and addresses for a partial name, in sections. Each item has the id, label, URL, province, coordinates and the number of listings. City items carry the city_id that the search and filters endpoints need. Send popular=true instead of a query to list the most listed cities and communities.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
string
Optional
Partial place name, e.g. calg. Required unless popular is true.
coffee shops
boolean
Optional
true to list the most listed cities and communities.
true
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"query": "calg",
"popular": false,
"sections": [
{
"type": "City",
"items": [
{
"id": 1,
"url": "https://www.rentfaster.ca/ab/calgary/rentals/",
"city": "Calgary",
"name": "Calgary, AB",
"slug": "/ab/calgary/rentals/",
"type": "City",
"label": "Calgary, AB",
"city_id": 1,
"is_fuzzy": false,
"latitude": 51.045833,
"province": "Alberta",
"longitude": -114.0575,
"listing_id": null,
"community_id": null,
"listing_count": 6746,
"province_code": "AB",
"is_autocorrect_match": false
}
],
"title": "Cities"
},
{
"type": "Community",
"items": [
{
"id": 17,
"url": "https://www.rentfaster.ca/ab/calgary/rentals/beltline/",
"city": "Calgary",
"name": "Beltline, Calgary",
"slug": "/ab/calgary/rentals/beltline/",
"type": "Community",
"label": "Beltline, Calgary, AB",
"city_id": 1,
"is_fuzzy": false,
"latitude": 51.04177,
"province": "Alberta",
"longitude": -114.07018,
"listing_id": null,
"community_id": 17,
"listing_count": 254,
"province_code": "AB",
"is_autocorrect_match": false
},
{
"id": 1687,
"url": "https://www.rentfaster.ca/ab/calgary/rentals/seton/",
"city": "Calgary",
"name": "Seton, Calgary",
"slug": "/ab/calgary/rentals/seton/",
"type": "Community",
"label": "Seton, Calgary, AB",
"city_id": 1,
"is_fuzzy": false,
"latitude": 50.879036,
"province": "Alberta",
"longitude": -113.952234,
"listing_id": null,
"community_id": 1687,
"listing_count": 183,
"province_code": "AB",
"is_autocorrect_match": false
}
],
"title": "Communities"
},
{
"type": "Address",
"items": [
{
"id": 582363,
"url": "https://www.rentfaster.ca/properties/bedridge-place-ne-calgary-calgary-582363",
"city": "Calgary",
"name": "Bedridge Place NE Calgary",
"slug": "/properties/bedridge-place-ne-calgary-calgary-582363",
"type": "Address",
"label": "Bedridge Place NE Calgary, Calgary, AB",
"units": 1,
"city_id": 1,
"summary": "2 Beds | 2 Baths",
"is_fuzzy": false,
"latitude": 51.126662,
"province": null,
"verified": true,
"longitude": -114.067527,
"listing_id": 582363,
"community_id": null,
"listing_count": null,
"property_name": null,
"property_type": "Townhouse",
"province_code": "AB",
"is_autocorrect_match": false
},
{
"id": 135278,
"url": "https://www.rentfaster.ca/properties/10-brentwood-common-nw-calgary-ab-canada-calgary-135278",
"city": "Calgary",
"name": "10 Brentwood common NW, Calgary, AB, Canada",
"slug": "/properties/10-brentwood-common-nw-calgary-ab-canada-calgary-135278",
"type": "Address",
"label": "10 Brentwood common NW, Calgary, AB, Canada, Calgary, AB",
"units": 1,
"city_id": 1,
"summary": "2 Beds | 2 Baths",
"is_fuzzy": false,
"latitude": 51.086943,
"province": null,
"verified": true,
"longitude": -114.128243,
"listing_id": 135278,
"community_id": null,
"listing_count": null,
"property_name": null,
"property_type": "Apartment",
"province_code": "AB",
"is_autocorrect_match": false
}
],
"title": "Addresses"
}
],
"total_items": 6
},
"meta": {
"billable": true,
"duration_ms": 900,
"endpoint_family": "autocomplete"
},
"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": {
"query": [
"Send a query, or popular=true for the most listed places."
]
},
"message": "The request validation failed"
}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": "autocomplete"
},
"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.