StreetEasy Sale Search API

Endpoint facts

Method

GET

API path

/streeteasy/sales/search

Auth

apiKey

Credits

5 credits/request

Charged on

Successful 2xx responses only

Platform

StreetEasy

Execution

Managed browser rendering where the target needs it

Response schema

#/definitions/streeteasy.SaleSearch

MCP tool

streeteasy_sales_search

How this endpoint behaves

MCP tool: streeteasy_sales_search

Query parameters:

• area_id is required and repeatable. Each value must exist in the live /streeteasy/areas catalog.
• sale_status may be repeated and accepts active, preview, coming_soon, in_contract, sold, and unavailable. The values map to StreetEasy's ACTIVE, PREVIEW, COMING_SOON, IN_CONTRACT, SOLD, and NO_LONGER_AVAILABLE. When omitted, active, preview, and coming-soon listings are searched. The public UI's “Active or in contract” option sends ACTIVE, IN_CONTRACT, PREVIEW, and COMING_SOON; callers can request exact statuses by repeating this parameter.
• sale_type may be repeated and accepts sponsor_unit, foreclosure, resale, and restricted_sale.
• page is a 1-based page number; default 1.
• per_page is from 1 to 500; default 500.
• sort accepts default, newest, recently_updated, price_desc, price_asc, largest, or smallest; default default. The UI labels map respectively to Default (se_score), Newest (listed_desc), Recently updated (interesting_desc), Most expensive (price_desc), Least expensive (price_asc), Largest (sqft_desc), and Smallest (sqft_asc). Each value was selected in StreetEasy's live sort dialog.
• min_price and max_price bound sale price. The UI presets available to either control are 100000, 150000, 200000, 250000, 300000, 400000, 500000, 600000, 700000, 800000, 900000, 1000000, 1250000, 1500000, 1750000, 2000000, 2250000, 2500000, 2750000, 3000000, 3500000, 4000000, 4500000, 5000000, 6000000, 7000000, 8000000, 9000000, 10000000, 12000000, 14000000, 16000000, 20000000, 25000000, and 30000000.
• min_bedrooms and max_bedrooms bound bedrooms. The UI options are Any, Studio, 1, 2, 3, and 4+; use zero for Studio and 4 as the lower bound for 4+.
• min_bathrooms and max_bathrooms bound bathrooms. The UI's preset choices are 1, 1.5, 2, and 3 or more.
• min_sqft and max_sqft bound square footage. The UI presets are 500, 600, 700, 800, 900, 1000, 1250, 1500, 2000, 2500, 3000, 3500, 4000, and 5000 square feet or more.
• min_maintenance and max_maintenance bound monthly maintenance. min_monthly_taxes and max_monthly_taxes bound monthly property taxes. Values are dollar amounts; both lower and upper bounds are supported.
• min_price_per_sqft and max_price_per_sqft bound price per square foot. include_unknown_price_per_sqft=true also includes listings for which StreetEasy has no price-per-square-foot value.
• min_year_built and max_year_built bound the building year. prewar=true selects prewar buildings.
• development accepts the verified value pre_construction, which selects pre-construction developments.
• income_restricted=true selects income-restricted listings.
• school_id may be repeated to filter by the numeric ID exposed when selecting a school in StreetEasy's search UI. The public UI currently supplies these IDs dynamically; the API does not yet expose a standalone school-ID catalog.
• zip_code accepts exactly five digits. keywords matches listing description text and accepts 1–200 non-whitespace characters.
• building_type may be repeated and accepts condo, co-op, house, and multifamily.
• amenity may be repeated for must-have amenities. Every listed value is required: 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, and storage.
• optional_amenity may be repeated for nice-to-have amenities. Results may omit these preferences; it accepts the same 23 values listed for amenity.
• pets_allowed, open_house, tour_3d, and video_tour are booleans. Open house means an event within the next seven days.
• transit_line may be repeated and accepts 1, 2, 3, 4, 5, 6, 7, A, C, E, B, D, F, M, G, N, Q, R, W, J, Z, L, S, HBLR, and PATH.

Each result edge includes type, the edge kind (for example, OrganicSaleEdge).

The response envelope contains search.criteria, totalCount, and edges. Each sale edge's node contains the sale-card fields selected by the public query, including price, saleType, offMarketAt, furnished, and the property address/unit fields. Sale nodes do not include the rental-only totalMonthlyPrice, status, or tier fields.

Example:

GET /api/v1/streeteasy/sales/search?area_id=201&area_id=401&sale_status=active&sale_status=coming_soon&sort=newest&min_bathrooms=3&building_type=condo&amenity=washer_dryer&optional_amenity=dishwasher&transit_line=1

Shared guides

Related