# Zumper Rental Facets

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.

- **Documentation:** [https://scrappa.co/docs/zumper-api/zumper_facets](https://scrappa.co/docs/zumper-api/zumper_facets)
- **API group:** Zumper API
- **Endpoint:** `GET https://scrappa.co/api/zumper/facets`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `city` | string | Yes | City slug: lower-case words and the state or province code, for example san-francisco-ca or toronto-on. |
| `hood` | string | No | Neighborhood slug inside the city, for example soma. Always used together with city. |
| `zip` | string | No | Five-digit ZIP code inside the city. Use hood or zip, not both. |
| `min_price` | integer | No | Lowest monthly rent. |
| `max_price` | integer | No | Highest monthly rent. |
| `bedrooms[]` | array | No | Bedroom counts to include, 0 for a studio. Repeat the parameter. |
| `min_bathrooms` | integer | No | Lowest bathroom count. |
| `max_bathrooms` | integer | No | Highest bathroom count. |
| `pets[]` | array | No | Pet policies to require: cat, small_dog, large_dog. |
| `categories[]` | array | No | Property categories: apartment, condo, house, room, townhouse, other. |
| `min_lat` | number | No | Southern edge of the map box. Give all four box values together. |
| `max_lat` | number | No | Northern edge of the map box. |
| `min_lng` | number | No | Western edge of the map box. |
| `max_lng` | number | No | Eastern edge of the map box. |
| `attribute` | string | Yes | Attribute to count by. Allowed: bedrooms, bathrooms, min_price, max_price, promotion, group_id, features. |
| `step` | integer | No | Bucket width. Price attributes want 100 or more. |
| `site` | string | No | zumper (default) or padmapper. Allowed: zumper, padmapper. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested listing, building, or page was not found. This response is not billable. |
| 422 | Validation Error | A required public parameter is missing or invalid. This response is not billable. |
| 503 | Service Unavailable | The service could not obtain a complete result. This response is not billable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)