Rentals.ca Neighbourhoods API lists the neighbourhoods of a city with their paths. Neighbourhood search is not supported by the search route, so use this list for navigation and mapping only. Failed requests are not billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
2 required parameters needed before sending a request.
2 optional filters available.
string
Required
City name. Example: Toronto.
example
string
Required
Province or territory code. Example: ON.
US
integer
Optional
One-based page number (default 1).
1
integer
Optional
Neighbourhoods per page, 1 to 100 (default 20).
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"page": 1,
"region": "ON",
"per_page": 3,
"next_page": 2,
"has_next_page": true,
"neighbourhoods": [
{
"url": "https://rentals.ca/toronto/alexandra-park",
"name": "Alexandra Park",
"path": "toronto/alexandra-park",
"region": "ON"
},
{
"url": "https://rentals.ca/toronto/allenby",
"name": "Allenby",
"path": "toronto/allenby",
"region": "ON"
},
{
"url": "https://rentals.ca/toronto/annex",
"name": "Annex",
"path": "toronto/annex",
"region": "ON"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "neighbourhoods"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required parameter, a range or a value is invalid. This response is not billable.
{
"errors": {
"city": [
"The city field is required."
]
},
"message": "The request validation failed"
}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.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "neighbourhoods"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Rentals.ca could not be reached. Please retry shortly."
},
"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.