# Madlan Neighborhood Insights API

Return the published neighbourhood insights for one Madlan neighbourhood: average rent yield and, where Madlan publishes it, the number of recorded deals and the average price per square metre. Average rent yield is the field Madlan populates for most neighbourhoods and is the one to rely on.

- **Documentation:** [https://scrappa.co/docs/madlan-api/madlan_neighborhood_insights](https://scrappa.co/docs/madlan-api/madlan_neighborhood_insights)
- **API group:** Madlan API
- **Endpoint:** `GET https://scrappa.co/api/madlan/neighborhood/insights`

## 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 |
| --- | --- | --- | --- |
| `doc_id` | string | Yes | Neighbourhood docId from the neighborhoods endpoint. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/madlan/neighborhood/insights?doc_id=%D7%A9%D7%9B%D7%95%D7%A0%D7%94-%D7%A8%D7%9E%D7%AA-%D7%90%D7%91%D7%99%D7%91-%D7%94%D7%97%D7%93%D7%A9%D7%94-%D7%AA%D7%9C-%D7%90%D7%91%D7%99%D7%91-%D7%99%D7%A9%D7%A8%D7%90%D7%9C"
```

## Example response

```json
{
    "success": true,
    "doc_id": "\u05e9\u05db\u05d5\u05e0\u05d4-\u05e8\u05de\u05ea-\u05d0\u05d1\u05d9\u05d1-\u05d4\u05d7\u05d3\u05e9\u05d4-\u05ea\u05dc-\u05d0\u05d1\u05d9\u05d1-\u05d9\u05e9\u05e8\u05d0\u05dc",
    "insights": {
        "averageRentYield": 0.0281,
        "dealsSummary": {
            "neighborhoodDocId": "\u05e9\u05db\u05d5\u05e0\u05d4-\u05e8\u05de\u05ea-\u05d0\u05d1\u05d9\u05d1-\u05d4\u05d7\u05d3\u05e9\u05d4-\u05ea\u05dc-\u05d0\u05d1\u05d9\u05d1-\u05d9\u05e9\u05e8\u05d0\u05dc",
            "totalDeals": 412,
            "averagePricePerMeter": 8421
        }
    },
    "notes": [
        "Average rent yield is the only field Madlan publishes here for most neighbourhoods; the crime comparison and price trend are frequently empty.",
        "This endpoint and the investor summary endpoint report the same average rent yield for the same neighbourhood."
    ],
    "meta": {
        "attempts": 1,
        "duration_ms": 267
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 503 | Madlan rejected the query | Madlan answered the request but refused to compute it. Branch on `error.code`: this response is not retryable. Nothing is charged for a failed request. |
| 503 | Madlan refused the request | Madlan answered with a client-side rejection before running the query, for example a bad path or an unsupported document. Retrying the same request changes nothing. Branch on `error.code`: this response is not retryable. Nothing is charged. |
| 503 | Madlan returned an unreadable response | Madlan answered, but not with the shape this endpoint reads, for example an HTML page where structured data was expected. The request was not answered, so it is not billed. Branch on `error.code`: this response is not retryable. |
| 503 | Madlan is temporarily unavailable | The upstream could not be reached, returned a server error, or throttled the request. `rate_limited_upstream` is the throttle path and is retryable once the wait has passed; `upstream_unavailable` covers a connection that could not be established, a server error, and a listing corpus that is still cold — the corpus is built in the background, so a cold one is a 503 that schedules a rebuild rather than a fan-out inside your request. Branch on `error.code`, then try again shortly. Nothing is charged. |
| 422 | Invalid parameters | One or more parameters are missing, out of range, or a filter Madlan cannot apply. Filters it cannot apply are refused rather than ignored, so the response never carries the unfiltered corpus in answer to a filter. The response lists the offending fields. |
| 404 | No record under that id | The id is well-formed and Madlan answered, but nothing is published under it. The body carries `found => false`. The lookup was answered, so it is billed; unlike a 503 this is not an upstream fault and retrying will not change it. |

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