Find your perfect rental
Zumper provides 4 tools that can be used to interact with its services.
get_building_floorplansFetch available floor plans for a building with pricing, specifications, and layout photos. Returns floorplan listings grouped by bedroom type. Called by widget when user views building details.
building_idinteger/stringThe building ID to fetch floorplans for
get_listing_cardbackRetrieve detailed listing information including full description, amenities list, pet policies, lease terms, and complete photo gallery. Called by widget for detail views.
building_idinteger/stringlisting_idinteger/stringpb_idinteger/stringpl_idinteger/stringget_rent_trendsGet historical rent trend data for a city or neighborhood, including median rent by bedroom type, month-over-month and year-over-year percent changes. Called by widget for rent trends tab. Falls back to city-level data if neighborhood data unavailable.
city_statestringCity and state in hyphenated URL format. Examples: 'san-francisco-ca', 'new-york-ny', 'miami-beach-fl', 'los-angeles-ca'. Format: lowercase, hyphenated, alphabetic only.
hood_urlstringOptional neighborhood in hyphenated URL format. Examples: 'mission', 'upper-west-side', 'south-beach', 'venice'. Format: lowercase, hyphenated, alphabetic only. Leave empty for city-level trends.
search_rentals🚨 MANDATORY: Call this tool IMMEDIATELY when user searches for RESIDENTIAL rental apartments, houses, or condos to live in. DO NOT call for: real estate for sale, car/vehicle rentals, rental insurance, or other non-residential rental products. NO conversational responses. NO confirmations. TOOL CALL ONLY. Map natural language to nearest parameter (fitness center→building_amenities:['gym'], dog-friendly→pet_policies:['small_dogs','large_dogs']). Merge new filters with CURRENT ACTIVE FILTERS from previous response. Returns widget with photos, map, trends.
address_locationstringFor specific street addresses or zip codes ONLY. Examples: '94102', '123 Main St, San Francisco, CA'. Mutually exclusive with 'city'/'state'.
amenitiesarrayUnit-level amenities to filter by. Valid values: 'parking', 'dishwasher', 'in_unit_laundry', 'air_conditioning', 'ceiling_fan', 'high_ceilings', 'fireplace', 'balcony', 'garden', 'deck', 'hardwood_floor', 'carpet', 'furnished', 'central_heat', 'walk_in_closets', 'outdoor_space', 'listing_pool', 'listing_ev_charging'. Examples: User says 'hardwood floors' → ['hardwood_floor']. User says 'dishwasher and parking' → ['dishwasher', 'parking']. User says 'in-unit laundry' → ['in_unit_laundry'].
bbox_eastnumberEastern longitude bound for viewport-based search (optional)
bbox_northnumberNorthern latitude bound for viewport-based search (optional)
bbox_southnumberSouthern latitude bound for viewport-based search (optional)
bbox_westnumberWestern longitude bound for viewport-based search (optional)
building_amenitiesarrayBuilding-level amenities to filter by. Valid values: 'gym', 'shared_laundry', 'package_service', 'residents_lounge', 'dry_cleaning_service', 'shared_parking', 'swimming_pool', 'storage', 'business_center', 'door_person', 'roof_deck', 'shared_outdoor_space', 'wheelchair_accessible', 'elevator', 'building_ev_charging'. Examples: User says 'gym' → ['gym']. User says 'pool and gym' → ['swimming_pool', 'gym']. User says 'elevator' → ['elevator'].
citystringCity name for the search (e.g., 'Miami', 'San Francisco', 'Brooklyn'). Required when not using address_location or bbox. Must be provided together with 'state'.
featuresarraySpecial property features to filter by. Valid values: 'specials', 'income_restricted', 'section_8', 'senior_living', 'student_housing', 'utilities_included', 'no_security_deposit'. Examples: User says 'utilities included' → ['utilities_included']. User says 'student housing' → ['student_housing']. User says 'no deposit' → ['no_security_deposit'].
limitintegerMaximum number of results (default: 25, max: 50)
25max_bathroomsintegerMaximum number of bathrooms
max_bedroomsintegerMaximum number of bedrooms
max_priceintegerMaximum monthly rent in USD
max_sqftintegerMaximum square footage
min_bathroomsintegerMinimum number of bathrooms
min_bedroomsintegerMinimum number of bedrooms (0 for studio)
min_priceintegerMinimum monthly rent in USD
min_sqftintegerMinimum square footage
neighborhoodstringOptional neighborhood name within the city (e.g., 'Mission District', 'South Beach').
pet_policiesarrayPet policies to filter by. Valid values: 'cats', 'small_dogs', 'large_dogs'. Examples: User says 'allows cats' → ['cats']. User says 'dog-friendly' → ['small_dogs', 'large_dogs']. User says 'pet-friendly' → ['cats', 'small_dogs', 'large_dogs'].
property_typesarrayList of property types to include
statestringTwo-letter state code (e.g., 'FL', 'CA', 'NY'). Required when 'city' is provided.