Returns the neighborhood, ZIP codes, and areas PadMapper knows for a city, or for one neighborhood when the location has one.
Run this endpoint
PadMapper Geos
1 credit/request
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.
location
string
Required
Location slug from autocomplete: city and state or province code, optionally with a neighborhood or ZIP, for example toronto-on, new-york-ny/chelsea or houston-tx/77002.
Example value
toronto-on
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"hood": {
"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
},
"cities": [
{
"box": [
-79.6393,
43.5796
],
"lat": 43.6532,
"lng": -79.3832,
"url": "toronto-on",
"name": "Toronto",
"path": "toronto-on",
"type": 1,
"index": true,
"state": "ON",
"city_id": 3191,
"country": "CAN",
"list_url": "/apartments/toronto-on",
"parent_id": null,
"index_attrs": "{\"beds\": {\"houses\": [], \"apartments\": [0, 1, 2, 3]}}",
"listing_count": 5344,
"listing_counts": {
"0": 43,
"1": 345,
"2": 66,
"4": 4730,
"5": 6,
"9": 44,
"13": 109,
"14": 1,
"long_term": 2066,
"short_term": 3
},
"main_image_url": null,
"index_attrs_json": {
"beds": {
"houses": [],
"apartments": [
0,
1
]
}
},
"inventory_counts": {
"0": {
"bedrooms": [
1,
21,
15,
5,
1
],
"amenities": {
"cheap": 26,
"luxury": 8,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 33,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"1": {
"bedrooms": [
10,
155,
141,
38,
1
],
"amenities": {
"cheap": 145,
"luxury": 143,
"furnished": 38,
"utilities": 5,
"low_income": 0,
"pet_friendly": 214,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"2": {
"bedrooms": [
3,
7,
22,
22,
7
],
"amenities": {
"cheap": 37,
"luxury": 7,
"furnished": 2,
"utilities": 0,
"low_income": 0,
"pet_friendly": 33,
"move_in_specials": 5,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"4": {
"bedrooms": [
359,
1000,
883,
287,
12
],
"amenities": {
"cheap": 1017,
"luxury": 436,
"furnished": 84,
"utilities": 85,
"low_income": 3,
"pet_friendly": 1137,
"move_in_specials": 547,
"short_term_lease": 0,
"no_security_deposit": 1
}
},
"5": {
"bedrooms": [
0,
3,
3,
0,
0
],
"amenities": {
"cheap": 0,
"luxury": 3,
"furnished": 2,
"utilities": 0,
"low_income": 0,
"pet_friendly": 5,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"9": {
"bedrooms": [
1,
3,
21,
15,
4
],
"amenities": {
"cheap": 38,
"luxury": 3,
"furnished": 9,
"utilities": 0,
"low_income": 0,
"pet_friendly": 30,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"13": {
"bedrooms": [
1,
20,
26,
39,
23
],
"amenities": {
"cheap": 68,
"luxury": 18,
"furnished": 21,
"utilities": 1,
"low_income": 0,
"pet_friendly": 72,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"14": {
"bedrooms": [
0,
0,
1,
0,
0
],
"amenities": {
"cheap": 1,
"luxury": 0,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 1,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"16": {
"bedrooms": [
15,
64,
4,
6,
4
],
"amenities": {
"cheap": 89,
"luxury": 0,
"furnished": 74,
"utilities": 0,
"low_income": 0,
"pet_friendly": 16,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
}
}
}
],
"zipcode": null,
"nearby_hoods": [
{
"box": [
-79.383113,
43.652415
],
"lat": 43.65902,
"lng": -79.376415,
"url": "/apartments/toronto-on/garden-district",
"city": "Toronto",
"name": "Garden District",
"path": "toronto-on/garden-district",
"type": 1,
"index": true,
"state": "ON",
"city_id": 3191,
"country": "CAN",
"list_url": "/apartments/toronto-on/garden-district",
"parent_id": null,
"index_attrs": null,
"listing_count": 185,
"main_image_url": null,
"verticals_json": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [
"/"
],
"rental_guide": false,
"rent_research": true
},
"city_state_name": "toronto-on/garden-district",
"latest_ppb_json": [
1803,
2855,
3680,
4715,
3195
],
"neighborhood_id": 43643,
"index_attrs_json": null
},
{
"box": [
-79.39636,
43.638702
],
"lat": 43.644566,
"lng": -79.388007,
"url": "/apartments/toronto-on/entertainment-district",
"city": "Toronto",
"name": "Entertainment District",
"path": "toronto-on/entertainment-district",
"type": 1,
"index": true,
"state": "ON",
"city_id": 3191,
"country": "CAN",
"list_url": "/apartments/toronto-on/entertainment-district",
"parent_id": null,
"index_attrs": null,
"listing_count": 86,
"main_image_url": null,
"verticals_json": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [
"/",
"/2-beds"
],
"rental_guide": false,
"rent_research": true
},
"city_state_name": "toronto-on/entertainment-district",
"latest_ppb_json": [
2376,
2762,
3704,
4800
],
"neighborhood_id": 43706,
"index_attrs_json": null
}
],
"nearby_cities": [
{
"box": [
-79.4287,
43.798
],
"lat": 43.8582922020198,
"lng": -79.3160118228625,
"url": "markham-on",
"name": "Markham",
"type": 1,
"index": true,
"state": "ON",
"city_id": 1892,
"country": "CAN",
"parent_id": null,
"index_attrs": null,
"listing_count": 51,
"listing_counts": {
"0": 1,
"1": 6,
"2": 3,
"4": 37,
"13": 4,
"long_term": 27,
"short_term": 0
},
"verticals_json": {
"rooms": [
"/"
],
"condos": [],
"houses": [
"/",
"/pet-friendly"
],
"apartments": [
"/",
"/2-beds"
],
"rental_guide": false,
"rent_research": true
},
"pmain_image_url": null,
"zmain_image_url": null,
"inventory_counts": {
"0": {
"bedrooms": [
0,
1,
0,
0,
0
],
"amenities": {
"cheap": 0,
"luxury": 0,
"furnished": 1,
"utilities": 0,
"low_income": 0,
"pet_friendly": 0,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"1": {
"bedrooms": [
0,
4,
2,
0,
0
],
"amenities": {
"cheap": 0,
"luxury": 4,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 1,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"2": {
"bedrooms": [
0,
0,
2,
1,
0
],
"amenities": {
"cheap": 1,
"luxury": 0,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 3,
"move_in_specials": 1,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"4": {
"bedrooms": [
1,
10,
7,
1,
0
],
"amenities": {
"cheap": 4,
"luxury": 10,
"furnished": 1,
"utilities": 1,
"low_income": 0,
"pet_friendly": 10,
"move_in_specials": 4,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"13": {
"bedrooms": [
0,
0,
0,
2,
2
],
"amenities": {
"cheap": 1,
"luxury": 0,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 2,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"16": {
"bedrooms": [
0,
2,
0,
0,
0
],
"amenities": {
"cheap": 2,
"luxury": 0,
"furnished": 2,
"utilities": 0,
"low_income": 0,
"pet_friendly": 0,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
}
}
},
{
"box": [
-79.4855,
43.8275
],
"lat": 43.9034298570783,
"lng": -79.4262057541328,
"url": "richmond-hill-on",
"name": "Richmond Hill",
"type": 1,
"index": true,
"state": "ON",
"city_id": 13496,
"country": "CAN",
"parent_id": null,
"index_attrs": null,
"listing_count": 38,
"listing_counts": {
"1": 3,
"2": 3,
"4": 27,
"13": 5,
"long_term": 26,
"short_term": 0
},
"verticals_json": {
"rooms": [
"/"
],
"condos": [],
"houses": [
"/"
],
"apartments": [
"/",
"/cheap"
],
"rental_guide": false,
"rent_research": true
},
"pmain_image_url": null,
"zmain_image_url": null,
"inventory_counts": {
"1": {
"bedrooms": [
0,
1,
2,
0,
0
],
"amenities": {
"cheap": 0,
"luxury": 1,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 2,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"2": {
"bedrooms": [
0,
0,
2,
1,
0
],
"amenities": {
"cheap": 0,
"luxury": 0,
"furnished": 0,
"utilities": 0,
"low_income": 0,
"pet_friendly": 3,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"4": {
"bedrooms": [
2,
7,
9,
1,
0
],
"amenities": {
"cheap": 5,
"luxury": 4,
"furnished": 5,
"utilities": 0,
"low_income": 0,
"pet_friendly": 5,
"move_in_specials": 3,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"13": {
"bedrooms": [
0,
2,
1,
1,
1
],
"amenities": {
"cheap": 3,
"luxury": 0,
"furnished": 3,
"utilities": 0,
"low_income": 0,
"pet_friendly": 2,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
},
"16": {
"bedrooms": [
2,
2,
0,
0,
0
],
"amenities": {
"cheap": 2,
"luxury": 1,
"furnished": 4,
"utilities": 0,
"low_income": 0,
"pet_friendly": 0,
"move_in_specials": 0,
"short_term_lease": 0,
"no_security_deposit": 0
}
}
}
}
],
"nearby_zipcodes": [
{
"box": [
-79.04963,
43.131584
],
"lat": 43.1735770624201,
"lng": -78.9936395357125,
"url": "/apartments/lewiston-ny/14092",
"city": "Lewiston",
"name": "14092",
"path": "lewiston-ny/14092",
"type": 2,
"index": false,
"state": "NY",
"city_id": 9469,
"country": "USA",
"list_url": "/apartments/lewiston-ny/14092",
"parent_id": null,
"index_attrs": null,
"listing_count": 2,
"main_image_url": null,
"verticals_json": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [],
"rent_research": false
},
"city_state_name": "lewiston-ny/14092",
"latest_ppb_json": {
"1": 953,
"2": 983,
"3": 1350
},
"neighborhood_id": 40021,
"index_attrs_json": null
},
{
"box": [
-79.067579,
43.093862
],
"lat": 43.1196081345354,
"lng": -79.022264591289,
"url": "/apartments/niagara-falls-ny/14305",
"city": "Niagara Falls",
"name": "14305",
"path": "niagara-falls-ny/14305",
"type": 2,
"index": false,
"state": "NY",
"city_id": 2186,
"country": "USA",
"list_url": "/apartments/niagara-falls-ny/14305",
"parent_id": null,
"index_attrs": null,
"listing_count": 12,
"main_image_url": null,
"verticals_json": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [],
"rent_research": false
},
"city_state_name": "niagara-falls-ny/14305",
"latest_ppb_json": {
"2": 1200,
"3": 1500,
"4": 1300
},
"neighborhood_id": 39757,
"index_attrs_json": null
}
],
"nearby_universities": [
{
"box": [
-79.1773071289062,
43.0371780395508
],
"lat": 43.1383605,
"lng": -79.0376672,
"url": "near-niagara-university-ny",
"name": "Niagara University",
"type": 4,
"index": true,
"state": "NY",
"city_id": 6224,
"country": "USA",
"parent_id": null,
"index_attrs": null,
"listing_count": 0,
"listing_counts": {
"long_term": 0,
"short_term": 0
},
"verticals_json": {
"rooms": [
"/"
],
"condos": [],
"houses": [
"/"
],
"apartments": [
"/"
],
"rental_guide": false,
"rent_research": true
},
"pmain_image_url": null,
"zmain_image_url": null,
"inventory_counts": null
},
{
"box": [
-79.1225967407227,
43.005298614502
],
"lat": 43.10648,
"lng": -78.98302,
"url": "near-cheryl-fell's-school-of-business-ny",
"name": "Cheryl Fell's School of Business",
"type": 4,
"index": false,
"state": "NY",
"city_id": 6108,
"country": "USA",
"parent_id": null,
"index_attrs": null,
"listing_count": 0,
"listing_counts": {
"long_term": 0,
"short_term": 0
},
"verticals_json": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [],
"rent_research": true
},
"pmain_image_url": null,
"zmain_image_url": null,
"inventory_counts": null
}
],
"nearby_military_bases": null
},
"meta": {
"duration_ms": 640,
"upstream_calls": 1,
"endpoint_family": "geos"
},
"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.