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.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
string
Optional
city (default), metro, or global. Allowed: city, metro, global.
example
string
Optional
City or metro slug, for example san-francisco-ca. Required for city and metro.
san-francisco-ca
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
success
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The requested listing, building, or page was not found. This response is not billable.
Validation Error
A required public parameter is missing or invalid. This response is not billable.
Service Unavailable
The service could not obtain a complete result. This response is not billable.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.