# Zumper Neighborhood

Returns the neighborhood record. Pass a ZIP code as hood to read a ZIP code page.

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

## 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 | Yes | Neighborhood slug inside the city, for example soma. Always used together with city. |
| `site` | string | No | zumper (default) or padmapper. Allowed: zumper, padmapper. |

## Example response

```json
{
    "data": {
        "box": [
            -122.42359
        ],
        "lat": 37.77731,
        "lng": -122.40535,
        "city": "San Francisco",
        "name": "SOMA",
        "color": null,
        "media": [],
        "state": "CA",
        "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)
