Returns the locale content Zumper shows on the city page: guide text and questions with answers.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
1 optional filter available.
string
Required
City slug: lower-case words and the state or province code, for example san-francisco-ca or toronto-on.
san-francisco-ca
string
Optional
zumper (default) or padmapper. Allowed: zumper, padmapper.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
success
{
"data": {
"content": [
{
"name": "what_locals_say",
"format": 1,
"header": "Local insights: What it's like to live in San Francisco, CA",
"content": [],
"section_order": 4
}
],
"enriched": {
"seo_survey": {
"dating": "48%",
"jobs_avg": "2.9",
"nightlife": "72%",
"dating_avg": "2.7",
"nightlife_avg": "3.1",
"cost_of_living": "18%",
"job_opportunity": "61%",
"avg_satisfaction": "3.1",
"overall_satisfaction": "61%",
"housing_affordability": "31%"
},
"cost_of_living": {
"body": [],
"categories": []
},
"transportation": {
"body": []
}
},
"editorial": {
"intro": {
"heading": "San Francisco, CA apartments for rent",
"body_markdown": "For over a hundred years, people have flocked to San Fran..."
},
"calculator": {
"heading": "How much can you afford to rent in SF?",
"body_markdown": "How much rent you can afford in SF depends on your income..."
},
"blog_spokes": {
"items": [],
"byline": null,
"heading": "Learn more about renting in San Francisco",
"body_markdown": null
},
"modified_on": 1787265729,
"availability": {
"heading": "What's available to rent in San Francisco right now?",
"body_markdown": "SF's market reaches its peak pricing in September when th..."
},
"good_to_know": {
"heading": "Good to know",
"body_markdown": "SF's rental market is highly competitive. Demand and pric..."
},
"neighborhoods": {
"items": [],
"byline": null,
"heading": "What neighborhoods in San Francisco should you consider?",
"body_markdown": "Renters who want classic San Francisco views or Victorian..."
},
"renters_rights": {
"items": [],
"byline": null,
"heading": "What are my rights as a renter in San Francisco?",
"body_markdown": "Looking for more information about your rights as a rente..."
},
"renter_insights": {
"items": [],
"byline": "Written by Hannah S, SF resident",
"heading": "Renter insights for San Francisco",
"body_markdown": null
},
"still_searching": {
"heading": "Still searching?",
"body_markdown": "If nothing in SF quite fits your needs, we recommend wide..."
}
}
},
"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.