streeteasy_sales_search
Search StreetEasy sale listings by area, status, sale type, price, rooms, maintenance, taxes, price per square foot, year built, prewar, development, income restriction, school, ZIP, keywords, building type, amenities, pets, open house, tours, transit, and sort. Status accepts active, preview, coming_soon, in_contract, sold, or unavailable; omitted status defaults to active, preview, and coming_soon. Sale type accepts sponsor_unit, foreclosure, resale, or restricted_sale. Use streeteasy_areas to find valid location IDs.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"area_id": "<area_id>"
},
"name": "streeteasy_sales_search"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | One-based result page. Defaults to 1. | |
| sort | No | Result order. Allowed values: default, newest, recently_updated, price_desc, price_asc, largest, smallest. | |
| prewar | No | Set true to select prewar buildings. | |
| amenity | No | Amenities: washer_dryer, dishwasher, private_outdoor_space, central_air, furnished, fireplace, loft, city_view, garden_view, park_view, skyline_view, water_view, elevator, doorman, laundry, gym, parking, shared_outdoor_space, pool, pied_a_terre, childrens_playroom, smoke_free, storage. | |
| area_id | Yes | Required. StreetEasy area IDs from streeteasy_areas; repeat for multiple areas. | |
| tour_3d | No | Require a 3D tour. | |
| keywords | No | StreetEasy listing-description keyword filter. | |
| max_sqft | No | Maximum square footage. | |
| min_sqft | No | Minimum square footage. UI presets are 500, 600, 700, 800, 900, 1000, 1250, 1500, 2000, 2500, 3000, 3500, 4000, and 5000 or more. | |
| per_page | No | Results per page, 1-500. Defaults to 500. | |
| zip_code | No | Five-digit ZIP code. | |
| max_price | No | Maximum sale price. StreetEasy UI presets range from 100000 through 30000000. | |
| min_price | No | Minimum sale price. StreetEasy UI presets range from 100000 through 30000000. | |
| sale_type | No | Sale types visible in StreetEasy filters: sponsor_unit, foreclosure, resale, restricted_sale. Repeat for multiple. | |
| school_id | No | StreetEasy school IDs selected by its public sale-search school filter; repeat for multiple schools. | |
| open_house | No | Require an open house within the next seven days. | |
| video_tour | No | Require a video tour. | |
| development | No | New development filter. Verified value: pre_construction. | |
| sale_status | No | Sale listing statuses: active, preview, coming_soon, in_contract, sold, unavailable. Repeat for multiple. Defaults to active, preview, and coming_soon. | |
| max_bedrooms | No | Maximum bedroom count; 0 means Studio and 4 means 4 or more. | |
| min_bedrooms | No | Minimum bedroom count; 0 means Studio and 4 means 4 or more. | |
| pets_allowed | No | Require listings that allow pets. | |
| transit_line | No | Transit lines: 1, 2, 3, 4, 5, 6, 7, A, C, E, B, D, F, M, G, N, Q, R, W, J, Z, L, S, HBLR, PATH. | |
| building_type | No | Building types: condo, co-op, house, multifamily. | |
| max_bathrooms | No | Maximum bathroom count. | |
| min_bathrooms | No | Minimum bathroom count. UI presets are 1, 1.5, 2, and 3 or more. | |
| 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 amenities; these are preferred but not required. Accepts the same values as amenity. | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | The tool result payload (shape varies per tool; see each tool's docs resource). |