Returns the city record: name, state, coordinates, map box, listing counts, bedroom counts, and the neighborhoods PadMapper tracks.
Run this endpoint
PadMapper City
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.
city
string
Required
City slug: lower-case words and the state or province code, for example houston-tx or toronto-on.
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": {
"box": [
-79.6393,
43.5796,
-79.1132
],
"lat": 43.6532,
"lng": -79.3832,
"url": "toronto-on",
"data": {
"nearby": {
"cities": [
{
"name": "Ajax",
"path": "ajax-on"
},
{
"name": "Brampton",
"path": "brampton-on"
},
{
"name": "Burlington",
"path": "burlington-on"
}
],
"universities": [
{
"name": "Canisius College",
"path": "near-canisius-college-ny"
},
{
"name": "D'Youville College",
"path": "near-d'youville-college-ny"
},
{
"name": "Niagara County Community College",
"path": "near-niagara-county-community-college-ny"
}
],
"neighborhoods": [
{
"name": "Bay Street Corridor",
"path": "toronto-on/bay-street-corridor"
},
{
"name": "High Park",
"path": "toronto-on/high-park"
},
{
"name": "Parkdale",
"path": "toronto-on/parkdale"
}
]
},
"verticals": {
"rooms": [
"/"
],
"condos": [],
"houses": [
"/",
"/2-beds",
"/3-beds"
],
"apartments": [
"/",
"/1-beds",
"/2-beds"
],
"rental_guide": false,
"rent_research": true
},
"vacation_verticals": [
"/"
],
"price_percentile_max": 3575,
"price_percentile_min": 2200
},
"html": null,
"name": "Toronto",
"path": "toronto-on",
"type": 1,
"index": true,
"state": "ON",
"osm_id": "relation/324211",
"city_id": 3191,
"country": "CAN",
"pricing": [
{
"avg_ppb": 2574,
"bedrooms": 0,
"avg_price": 1802,
"median_ppb": 2500,
"cardinality": 763,
"median_price": 1750,
"stddev_price": 333
},
{
"avg_ppb": 2207,
"bedrooms": 1,
"avg_price": 2207,
"median_ppb": 2100,
"cardinality": 3117,
"median_price": 2100,
"stddev_price": 493
},
{
"avg_ppb": 1472,
"bedrooms": 2,
"avg_price": 2945,
"median_ppb": 1360,
"cardinality": 2610,
"median_price": 2720,
"stddev_price": 950
}
],
"list_url": "/apartments/toronto-on",
"parent_id": null,
"verticals": {
"rooms": [
"/"
],
"condos": [],
"houses": [
"/",
"/2-beds",
"/3-beds"
],
"apartments": [
"/",
"/1-beds",
"/2-beds"
],
"rental_guide": false,
"rent_research": true
},
"created_on": 1409511279,
"index_attrs": "{\"beds\": {\"houses\": [], \"apartments\": [0, 1, 2, 3]}}",
"modified_on": 1778623662,
"listing_count": 5344,
"neighborhoods": [
{
"box": [
-79.41142,
43.70465,
-79.37705
],
"lat": 43.712338,
"lng": -79.394277,
"url": "/apartments/toronto-on/north-toronto",
"city": "Toronto",
"data": {
"nearby": {
"cities": [
{
"name": "Ajax",
"path": "ajax-on"
},
{
"name": "Brampton",
"path": "brampton-on"
},
{
"name": "Burlington",
"path": "burlington-on"
}
],
"universities": [
{
"name": "Canisius College",
"path": "near-canisius-college-ny"
},
{
"name": "D'Youville College",
"path": "near-d'youville-college-ny"
},
{
"name": "Niagara County Community College",
"path": "near-niagara-county-community-college-ny"
}
],
"neighborhoods": [
{
"name": "Broadview North",
"path": "toronto-on/broadview-north"
},
{
"name": "Chaplin Estates",
"path": "toronto-on/chaplin-estates"
},
{
"name": "Davisville Village",
"path": "toronto-on/davisville-village"
}
]
},
"verticals": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [
"/",
"/2-beds",
"/pet-friendly"
],
"rental_guide": false,
"rent_research": true
},
"price_percentile_max": 2903,
"price_percentile_min": 1950
},
"html": null,
"name": "North Toronto",
"path": "toronto-on/north-toronto",
"type": 1,
"color": null,
"index": true,
"media": [],
"state": "ON",
"city_id": 3191,
"country": "CAN",
"pricing": [
{
"avg_ppb": 2081,
"bedrooms": -1,
"avg_price": 2613,
"median_ppb": 2025,
"cardinality": 379,
"median_price": 2409,
"stddev_price": 798
},
{
"avg_ppb": 2700,
"bedrooms": 0,
"avg_price": 1890,
"median_ppb": 2813,
"cardinality": 69,
"median_price": 1969,
"stddev_price": 213
},
{
"avg_ppb": 2283,
"bedrooms": 1,
"avg_price": 2283,
"median_ppb": 2345,
"cardinality": 169,
"median_price": 2345,
"stddev_price": 348
}
],
"list_url": "/apartments/toronto-on/north-toronto",
"parent_id": null,
"index_attrs": null,
"listing_count": 263,
"bedroom_counts": [
57,
103,
79,
24
],
"encoded_bounds": [],
"main_image_url": null,
"city_state_name": "toronto-on/north-toronto",
"latest_ppb_json": [
1969,
2345,
3149,
4303,
5275
],
"neighborhood_id": 44437,
"index_attrs_json": null,
"latest_property_type_ppb_json": {
"condos": {
"2": 2900
},
"apartments": [
1969,
2350,
3159,
4303
]
}
},
{
"box": [
-79.383113,
43.652415,
-79.3701
],
"lat": 43.65902,
"lng": -79.376415,
"url": "/apartments/toronto-on/garden-district",
"city": "Toronto",
"data": {
"nearby": {
"cities": [
{
"name": "Ajax",
"path": "ajax-on"
},
{
"name": "Brampton",
"path": "brampton-on"
},
{
"name": "Burlington",
"path": "burlington-on"
}
],
"universities": [
{
"name": "Canisius College",
"path": "near-canisius-college-ny"
},
{
"name": "D'Youville College",
"path": "near-d'youville-college-ny"
},
{
"name": "Niagara County Community College",
"path": "near-niagara-county-community-college-ny"
}
],
"neighborhoods": [
{
"name": "Bay Street Corridor",
"path": "toronto-on/bay-street-corridor"
},
{
"name": "Entertainment District",
"path": "toronto-on/entertainment-district"
},
{
"name": "Harbourfront",
"path": "toronto-on/harbourfront"
}
]
},
"verticals": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [
"/"
],
"rental_guide": false,
"rent_research": true
},
"price_percentile_max": 3500,
"price_percentile_min": 2180
},
"html": null,
"name": "Garden District",
"path": "toronto-on/garden-district",
"type": 1,
"color": null,
"index": true,
"media": [],
"state": "ON",
"city_id": 3191,
"country": "CAN",
"pricing": [
{
"avg_ppb": 2212,
"bedrooms": -1,
"avg_price": 3261,
"median_ppb": 2070,
"cardinality": 235,
"median_price": 3200,
"stddev_price": 1102
},
{
"avg_ppb": 2740,
"bedrooms": 0,
"avg_price": 1918,
"median_ppb": 2579,
"cardinality": 32,
"median_price": 1805,
"stddev_price": 348
},
{
"avg_ppb": 2704,
"bedrooms": 1,
"avg_price": 2704,
"median_ppb": 2860,
"cardinality": 83,
"median_price": 2860,
"stddev_price": 634
}
],
"list_url": "/apartments/toronto-on/garden-district",
"parent_id": null,
"index_attrs": null,
"listing_count": 185,
"bedroom_counts": [
28,
63,
61,
33
],
"encoded_bounds": [],
"main_image_url": null,
"city_state_name": "toronto-on/garden-district",
"latest_ppb_json": [
1805,
2860,
3699,
4865,
3195
],
"neighborhood_id": 43643,
"index_attrs_json": null,
"latest_property_type_ppb_json": {
"condos": {
"1": 2100,
"2": 3000
},
"apartments": [
1805,
2885,
3770,
4928
]
}
},
{
"box": [
-79.457879,
43.714081,
-79.444217
],
"lat": 43.721772,
"lng": -79.45144,
"url": "/apartments/toronto-on/lawrence-heights",
"city": "Toronto",
"data": {
"nearby": {
"cities": [
{
"name": "Ajax",
"path": "ajax-on"
},
{
"name": "Brampton",
"path": "brampton-on"
},
{
"name": "Burlington",
"path": "burlington-on"
}
],
"universities": [
{
"name": "Canisius College",
"path": "near-canisius-college-ny"
},
{
"name": "D'Youville College",
"path": "near-d'youville-college-ny"
},
{
"name": "Niagara County Community College",
"path": "near-niagara-county-community-college-ny"
}
],
"neighborhoods": [
{
"name": "Briar Hill - Belgravia",
"path": "toronto-on/briar-hill-belgravia"
},
{
"name": "Cedarvale",
"path": "toronto-on/cedarvale"
},
{
"name": "Clanton Park",
"path": "toronto-on/clanton-park"
}
]
},
"verticals": {
"rooms": [],
"condos": [],
"houses": [],
"apartments": [
"/"
],
"rental_guide": false,
"rent_research": false
},
"price_percentile_max": 2180,
"price_percentile_min": 1950
},
"html": null,
"name": "Lawrence Heights",
"path": "toronto-on/lawrence-heights",
"type": 1,
"color": null,
"index": true,
"media": [],
"state": "ON",
"city_id": 3191,
"country": "CAN",
"pricing": [
{
"avg_ppb": 2324,
"bedrooms": -1,
"avg_price": 3518,
"median_ppb": 1998,
"cardinality": 167,
"median_price": 3435,
"stddev_price": 770
},
{
"avg_ppb": 3304,
"bedrooms": 0,
"avg_price": 2312,
"median_ppb": 3311,
"cardinality": 10,
"median_price": 2318,
"stddev_price": 25
},
{
"avg_ppb": 2989,
"bedrooms": 1,
"avg_price": 2989,
"median_ppb": 2995,
"cardinality": 60,
"median_price": 2995,
"stddev_price": 179
}
],
"list_url": "/apartments/toronto-on/lawrence-heights",
"parent_id": null,
"index_attrs": null,
"listing_count": 147,
"bedroom_counts": [
9,
52,
66,
20
],
"encoded_bounds": [],
"main_image_url": null,
"city_state_name": "toronto-on/lawrence-heights",
"latest_ppb_json": [
2318,
2995,
3770,
3968
],
"neighborhood_id": 14643,
"index_attrs_json": null,
"latest_property_type_ppb_json": {
"apartments": [
2318,
2995,
3770,
3993
]
}
}
],
"bedroom_counts": [
549,
2221,
1940,
656,
52
],
"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,
2
]
}
},
"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
}
}
},
"neighborhood_ids": [
44437,
43643,
14643
]
},
"meta": {
"duration_ms": 640,
"upstream_calls": 1,
"endpoint_family": "city"
},
"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.