# Zumper Rental Search

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.

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

## 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. |
| `sort` | string | No | Sort order: relevance1, newest, price (low first), -price (high first), rating, -rating. |
| `limit` | integer | No | Page size, 20 to 100. Default 25. |
| `offset` | integer | No | Number of results to skip, up to 5000. |
| `site` | string | No | zumper (default) or padmapper. Allowed: zumper, padmapper. |

## Example response

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

| 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)