# Zumper Neighborhoods

Returns the neighborhoods (hood_type 1, default) or the larger areas (hood_type 2) inside a map box, with their slugs and shapes. Set site to padmapper to use the PadMapper index.

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

## 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 |
| --- | --- | --- | --- |
| `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. |
| `hood_type` | string | No | 1 for neighborhoods (default), 2 for larger areas. Allowed: 1, 2. |
| `site` | string | No | zumper (default) or padmapper. Allowed: zumper, padmapper. |

## Example response

```json
{
    "data": {
        "count": 43,
        "items": [
            {
                "lat": 37.77731,
                "lng": -122.40535,
                "city": "San Francisco",
                "name": "SOMA",
                "type": 1,
                "state": "CA",
                "city_id": 2777,
                "listing_count": 207,
                "city_state_name": "san-francisco-ca/soma",
                "neighborhood_id": 247
            }
        ]
    },
    "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)