# Zumper Rent Research

view=summary (default) returns the rent research of a city with its neighborhoods. view=details returns the longer data set and, with hood, the neighborhood data. view=page returns the research page content for a city or neighborhood slug. The summary payload can be large.

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

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

## Example response

```json
{
    "data": {
        "data": {
            "bed": {
                "1_BED": [],
                "2_BED": [],
                "3_BED": [],
                "4+_BED": [],
                "STUDIO": []
            },
            "url": "san-francisco-ca",
            "city": "San Francisco",
            "hood": "",
            "state": "CA",
            "feature": null,
            "property_type": {
                "AFR": [],
                "CFR": [],
                "HFR": [],
                "RFR": []
            },
            "bed_property_type": {
                "1_BED": [],
                "2_BED": [],
                "3_BED": [],
                "4+_BED": [],
                "STUDIO": []
            },
            "feature_property_type": null,
            "feature_bed_property_type": null
        },
        "hoods": [
            {
                "bed": [],
                "url": "san-francisco-ca/soma",
                "city": "San Francisco",
                "hood": "Soma",
                "state": "CA",
                "feature": null,
                "property_type": [],
                "bed_property_type": [],
                "feature_property_type": null,
                "feature_bed_property_type": null
            }
        ],
        "nearby": [
            {
                "bed": [],
                "url": "alameda-ca",
                "city": "Alameda",
                "hood": "",
                "state": "CA",
                "feature": null,
                "property_type": [],
                "bed_property_type": [],
                "feature_property_type": null,
                "feature_bed_property_type": null
            }
        ],
        "national": {
            "bed": {
                "1_BED": [],
                "2_BED": [],
                "3_BED": [],
                "4+_BED": [],
                "STUDIO": []
            },
            "url": "all",
            "city": "all",
            "hood": "",
            "state": "all",
            "feature": null,
            "property_type": {
                "AFR": [],
                "CFR": [],
                "HFR": [],
                "RFR": []
            },
            "bed_property_type": {
                "1_BED": [],
                "2_BED": [],
                "3_BED": [],
                "4+_BED": [],
                "STUDIO": []
            },
            "feature_property_type": null,
            "feature_bed_property_type": null
        },
        "key_takeaways": [
            "### Where San Francisco rent stands today\n\nSan Francisco,..."
        ]
    },
    "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)