Returns the neighborhoods (hood_type 1, default) or the larger areas (hood_type 2) inside a map box, with their slugs, listing counts, and shapes.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
4 required parameters needed before sending a request.
1 optional filter available.
number
Required
Southern edge of the map box.
43.65
number
Required
Northern edge of the map box.
43.68
number
Required
Western edge of the map box.
-79.43
number
Required
Eastern edge of the map box.
-79.39
string
Optional
1 for neighborhoods (default), 2 for larger areas. Allowed: 1, 2.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"count": 2,
"items": [
{
"box": [
-79.394169,
43.644209
],
"lat": 43.657512,
"lng": -79.385511,
"url": "/apartments/toronto-on/bay-street-corridor",
"city": "Toronto",
"name": "Bay Street Corridor",
"path": "toronto-on/bay-street-corridor",
"type": 1,
"index": true,
"state": "ON",
"city_id": 3191,
"country": "CAN",
"list_url": "/apartments/toronto-on/bay-street-corridor",
"parent_id": null,
"index_attrs": null,
"listing_count": 117,
"main_image_url": null,
"city_state_name": "toronto-on/bay-street-corridor",
"latest_ppb_json": [
2149,
2460,
3499,
4459
],
"neighborhood_id": 43821,
"index_attrs_json": null
},
{
"box": [
-79.4256539,
43.654359
],
"lat": 43.660222,
"lng": -79.412723,
"url": "/apartments/toronto-on/south-annex",
"city": "Toronto",
"name": "South Annex",
"path": "toronto-on/south-annex",
"type": 1,
"index": true,
"state": "ON",
"city_id": 3191,
"country": "CAN",
"list_url": "/apartments/toronto-on/south-annex",
"parent_id": null,
"index_attrs": null,
"listing_count": 86,
"main_image_url": null,
"city_state_name": "toronto-on/south-annex",
"latest_ppb_json": [
2332,
2527,
3300,
4100,
4850
],
"neighborhood_id": 43819,
"index_attrs_json": null
}
]
},
"meta": {
"duration_ms": 640,
"upstream_calls": 1,
"endpoint_family": "neighborhoods"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The requested listing, building, agent, or city was not found. Rent reports exist for US cities only. This response is not billable.
Validation Error
A required public parameter is missing or invalid. This response is not billable.
Service Unavailable
The service could not obtain a complete result. This response is not billable.
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.