# Zumper Map Search

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.

- **Documentation:** [https://scrappa.co/docs/zumper-api/zumper_map_search](https://scrappa.co/docs/zumper-api/zumper_map_search)
- **API group:** Zumper API
- **Endpoint:** `GET https://scrappa.co/api/zumper/map-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. |
| `min_lat` | number | Yes | Southern edge of the map box. Give all four box values together. |
| `max_lat` | number | Yes | Northern edge of the map box. |
| `min_lng` | number | Yes | Western edge of the map box. |
| `max_lng` | number | Yes | Eastern edge of the map box. |
| `min_price` | integer | No | Lowest monthly rent. |
| `max_price` | integer | No | Highest monthly rent. |
| `min_bedrooms` | integer | No | Lowest bedroom count. |
| `max_bedrooms` | integer | No | Highest bedroom count. |
| `min_bathrooms` | integer | No | Lowest bathroom count. |
| `max_bathrooms` | integer | No | Highest bathroom count. |
| `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": "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

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