# PadMapper Neighborhoods

Returns the neighborhoods (hood_type 1, default) or the larger areas (hood_type 2) inside a map box, with their slugs, listing counts, and shapes.

- **Documentation:** [https://scrappa.co/docs/padmapper-api/padmapper_neighborhoods](https://scrappa.co/docs/padmapper-api/padmapper_neighborhoods)
- **API group:** PadMapper API
- **Endpoint:** `GET https://scrappa.co/api/padmapper/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. |
| `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. |

## Example response

```json
{
    "data": {
        "count": 2,
        "items": [
            {
                "box": [
                    -79.394169,
                    43.644209
                ],
                "lat": 43.657512,
                "lng": -79.385511,
                "url": "/apartments/toronto-on/bay-street-corridor",
                "city": "Toronto",
                "name": "Bay Street Corridor",
                "path": "toronto-on/bay-street-corridor",
                "type": 1,
                "index": true,
                "state": "ON",
                "city_id": 3191,
                "country": "CAN",
                "list_url": "/apartments/toronto-on/bay-street-corridor",
                "parent_id": null,
                "index_attrs": null,
                "listing_count": 117,
                "main_image_url": null,
                "city_state_name": "toronto-on/bay-street-corridor",
                "latest_ppb_json": [
                    2149,
                    2460,
                    3499,
                    4459
                ],
                "neighborhood_id": 43821,
                "index_attrs_json": null
            },
            {
                "box": [
                    -79.4256539,
                    43.654359
                ],
                "lat": 43.660222,
                "lng": -79.412723,
                "url": "/apartments/toronto-on/south-annex",
                "city": "Toronto",
                "name": "South Annex",
                "path": "toronto-on/south-annex",
                "type": 1,
                "index": true,
                "state": "ON",
                "city_id": 3191,
                "country": "CAN",
                "list_url": "/apartments/toronto-on/south-annex",
                "parent_id": null,
                "index_attrs": null,
                "listing_count": 86,
                "main_image_url": null,
                "city_state_name": "toronto-on/south-annex",
                "latest_ppb_json": [
                    2332,
                    2527,
                    3300,
                    4100,
                    4850
                ],
                "neighborhood_id": 43819,
                "index_attrs_json": null
            }
        ]
    },
    "meta": {
        "duration_ms": 640,
        "upstream_calls": 1,
        "endpoint_family": "neighborhoods"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested listing, building, agent, or city was not found. Rent reports exist for US cities only. 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)