StreetEasy

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.

get/streeteasy/rentals/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/streeteasy/rentals/search
  • Auth: API key in header x-api-key

Query parameters

area_idinteger[] required

StreetEasy area ID from /streeteasy/areas; repeat for multiple areas

pageinteger

1-based result page

per_pageinteger

Results per page, 1-500

sort'default' | 'newest' | 'recently_updated' | 'price_desc' | 'price_asc' | 'largest' | 'smallest'

Result order

min_priceinteger

Minimum monthly rent

max_priceinteger

Maximum monthly rent

min_bedroomsinteger

Minimum bedrooms; zero means studio

max_bedroomsinteger

Maximum bedrooms

min_bathroomsnumber

Minimum bathrooms

max_bathroomsnumber

Maximum bathrooms

min_sqftinteger

Minimum square footage

max_sqftinteger

Maximum square footage

building_typestring[]

Building type; repeat for multiple

amenitystring[]

Required amenity; repeat for multiple

optional_amenitystring[]

Preferred amenity; results may omit these. Repeat for multiple.

pets_allowedboolean

Require listings that allow pets

open_houseboolean

Require an open house within the next seven days

tour_3dboolean

Require a 3D tour

video_tourboolean

Require a video tour

transit_linestring[]

Nearby transit line; repeat for multiple

Headers

x-api-keystring required

API key required

Response

OK

totalCountinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.