Counts matching rentals per bucket for one attribute. Price buckets are keyed by their lower edge, so a bucket labelled 2000 with step 500 holds rents from 2000 up to the next edge. Offered attributes: bedrooms, bathrooms, min_price, max_price, promotion, group_id, features. 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
2 required parameters needed before sending a request.
15 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
Required
Attribute to count by. Allowed: bedrooms, bathrooms, min_price, max_price, promotion, group_id, features.
min_price
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.
10
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
integer
Optional
Bucket width. Price attributes want 100 or more.
500
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": {
"step": 500,
"buckets": [
{
"edge": 0,
"count": 1
}
],
"attribute": "min_price",
"min_price": {
"0": 1,
"500": 11,
"1000": 7,
"1500": 27,
"2000": 24,
"2500": 45,
"3000": 51,
"3500": 70,
"4000": 82,
"4500": 79
}
},
"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.