# Zumper Rent Report

scope=city (default) returns the rent report of a city, scope=metro of a metro area, scope=global the national report with its document body.

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

## 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 |
| --- | --- | --- | --- |
| `scope` | string | No | city (default), metro, or global. Allowed: city, metro, global. |
| `slug` | string | No | City or metro slug, for example san-francisco-ca. Required for city and metro. |

## Example response

```json
{
    "data": {
        "url": "san-francisco-ca",
        "intro": "The Zumper San Francisco Bay Area Metro Report analyzed a...",
        "created_on": 1740100204,
        "metro_name": "San Francisco Bay Area",
        "modified_on": 1791468112,
        "image_one_url": "https://img.zumpercdn.com/s3_images/Cities_Ranked_by_1_Be...",
        "image_two_url": "https://img.zumpercdn.com/s3_images/Yearly_1-Br_Rent_Evol...",
        "image_three_url": "https://img.zumpercdn.com/s3_images/Price_Table_77_OWfX5Z...",
        "metro_rent_report_id": 256,
        "most_expensive_first": "ranked as the most expensive city with one-bedrooms price..."
    },
    "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)