streeteasy_sales_search
Search StreetEasy sale listings by area, price, bedrooms, amenities, status, and transit to find properties that match specific buying criteria.
Instructions
Search StreetEasy sale listings. Searches public sale listings with location, status, sale type, price, bedroom, bathroom, square-footage, carrying cost, building age, school, ZIP, keyword, building type, amenity, pet, open-house, virtual-tour, transit, and sort filters. Obtain area IDs from /streeteasy/areas. When sale_status is omitted, active, preview, and coming_soon listings are included.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based result page | |
| sort | No | default, newest, recently_updated, price_desc, price_asc, largest, or smallest | |
| prewar | No | Set true to select prewar buildings | |
| amenity | No | Amenity filter; repeat for multiple | |
| area_id | Yes | StreetEasy area ID from /streeteasy/areas; repeat for multiple areas | |
| tour_3d | No | Require a 3D tour | |
| keywords | No | Listing-description keyword filter | |
| max_sqft | No | Maximum square footage | |
| min_sqft | No | Minimum square footage | |
| per_page | No | Results per page, 1-500 | |
| zip_code | No | Five-digit ZIP code | |
| max_price | No | Maximum sale price | |
| min_price | No | Minimum sale price | |
| sale_type | No | Sale type; repeat for multiple. | |
| school_id | No | StreetEasy school ID selected by the public search UI; repeat for multiple schools | |
| open_house | No | Require open house within the next seven days | |
| video_tour | No | Require a video tour | |
| development | No | New development filter | |
| sale_status | No | Sale status; repeat for multiple. Defaults to active, preview, and coming_soon. | |
| max_bedrooms | No | Maximum bedrooms | |
| min_bedrooms | No | Minimum bedrooms; zero means studio | |
| pets_allowed | No | Require pets allowed | |
| transit_line | No | Nearby transit line; repeat for multiple | |
| building_type | No | Building type | |
| max_bathrooms | No | Maximum bathrooms | |
| min_bathrooms | No | Minimum bathrooms | |
| max_year_built | No | Maximum building year built | |
| min_year_built | No | Minimum building year built | |
| max_maintenance | No | Maximum monthly maintenance fee | |
| min_maintenance | No | Minimum monthly maintenance fee | |
| optional_amenity | No | Nice-to-have amenity; results may omit these. Repeat for multiple. | |
| income_restricted | No | Set true to select income-restricted homes | |
| max_monthly_taxes | No | Maximum monthly property taxes | |
| min_monthly_taxes | No | Minimum monthly property taxes | |
| max_price_per_sqft | No | Maximum price per square foot | |
| min_price_per_sqft | No | Minimum price per square foot | |
| include_unknown_price_per_sqft | No | Include listings with unknown price per square foot |