streeteasy_rentals_search
Search active StreetEasy rental listings by area, then filter by price, rooms, amenities, pets, transit, tours, and sort order. Use area IDs from /streeteasy/areas.
Instructions
Search StreetEasy rental listings. Searches active StreetEasy rentals in one or more areas with the public site's price, room, building, amenity, pet, open-house, tour, transit, and sort filters. Obtain valid area IDs from /streeteasy/areas.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based result page | |
| sort | No | Result order | |
| amenity | No | Required amenity; repeat for multiple | |
| area_id | Yes | StreetEasy area ID from /streeteasy/areas; repeat for multiple areas | |
| tour_3d | No | Require a 3D tour | |
| max_sqft | No | Maximum square footage | |
| min_sqft | No | Minimum square footage | |
| per_page | No | Results per page, 1-500 | |
| max_price | No | Maximum monthly rent | |
| min_price | No | Minimum monthly rent | |
| open_house | No | Require an open house within the next seven days | |
| video_tour | No | Require a video tour | |
| max_bedrooms | No | Maximum bedrooms | |
| min_bedrooms | No | Minimum bedrooms; zero means studio | |
| pets_allowed | No | Require listings that allow pets | |
| transit_line | No | Nearby transit line; repeat for multiple | |
| building_type | No | Building type; repeat for multiple | |
| max_bathrooms | No | Maximum bathrooms | |
| min_bathrooms | No | Minimum bathrooms | |
| optional_amenity | No | Preferred amenity; results may omit these. Repeat for multiple. |