Searches US and Canada rentals. Pass a city slug, optionally with a neighborhood or ZIP, or give a map box. Filter by rent, bedrooms, bathrooms, pets, and category, sort, and page with limit and offset. Each listing card carries address, coordinates, rent range, beds, baths, area, pets, amenities, images, building, and agent data. matching is the total hit count for the filters. An unknown sort is rejected locally and never billed. 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
1 required parameter needed before sending a request.
17 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
string
Optional
Neighborhood slug inside the city, for example soma. Always used together with city.
example
string
Optional
Five-digit ZIP code inside the city. Use hood or zip, not both.
example
integer
Optional
Lowest monthly rent.
10
integer
Optional
Highest monthly rent.
4000
array
Optional
Bedroom counts to include, 0 for a studio. Repeat the parameter.
["example"]
integer
Optional
Lowest bathroom count.
10
integer
Optional
Highest bathroom count.
10
array
Optional
Pet policies to require: cat, small_dog, large_dog.
["example"]
array
Optional
Property categories: apartment, condo, house, room, townhouse, other.
["example"]
number
Optional
Southern edge of the map box. Give all four box values together.
10
number
Optional
Northern edge of the map box.
10
number
Optional
Western edge of the map box.
10
number
Optional
Eastern edge of the map box.
10
string
Optional
Sort order: relevance1, newest, price (low first), -price (high first), rating, -rating.
price
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": "price",
"limit": 25,
"total": 98,
"offset": 0,
"filters": {
"pets": null,
"user_id": null,
"bedrooms": [
0
],
"external": false,
"max_price": null,
"min_price": null,
"min_listed_on": null,
"favorites_only": null,
"viewing_end_after": null,
"viewing_begin_before": null
},
"featured": null,
"has_more": true,
"listings": [
{
"lat": 37.796677,
"lng": -122.405349,
"city": "San Francisco",
"address": "935 Kearny St",
"group_id": -2028071,
"listed_on": 1792064029,
"created_on": 1769838790,
"listing_id": 63533342,
"modified_on": 1792150774,
"listing_status": 1
}
],
"matching": 98,
"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.