Searches the rentals inside a map box, the way the map view does. Returns the listing cards, the total, featured listings, nearby results, and commute fields when the area has them. Use search for city and neighborhood lookups. Set site to padmapper to read the PadMapper side of the same inventory.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
5 required parameters needed before sending a request.
9 optional filters available.
string
Required
City slug: lower-case words and the state or province code, for example san-francisco-ca or toronto-on.
san-francisco-ca
number
Required
Southern edge of the map box. Give all four box values together.
37.74
number
Required
Northern edge of the map box.
37.8
number
Required
Western edge of the map box.
-122.46
number
Required
Eastern edge of the map box.
-122.38
integer
Optional
Lowest monthly rent.
10
integer
Optional
Highest monthly rent.
10
integer
Optional
Lowest bedroom count.
10
integer
Optional
Highest bedroom count.
10
integer
Optional
Lowest bathroom count.
10
integer
Optional
Highest bathroom count.
10
integer
Optional
Page size, 20 to 100. Default 25.
25
integer
Optional
Number of results to skip, up to 5000.
10
string
Optional
zumper (default) or padmapper. Allowed: zumper, padmapper.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
success
{
"data": {
"sort": "relevance1",
"limit": 25,
"total": 491,
"nearby": null,
"offset": 0,
"featured": null,
"has_more": true,
"listings": [
{
"lat": 37.78714246632131,
"lng": -122.39963719035394,
"city": "San Francisco",
"address": "149 San Francisco New Montgomery St #1161",
"group_id": -1717500,
"listed_on": 1792422004,
"created_on": 1722455026,
"listing_id": 58574872,
"modified_on": 1792447247,
"listing_status": 1
}
],
"matching": 491,
"returned": 25
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The requested listing, building, or page was not found. 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.