StreetEasy APIstreeteasy.com ↗
Search and retrieve NYC apartment rental listings from StreetEasy. Filter by bedrooms, price, neighborhood, and amenities. Returns pricing, photos, and broker details.
What is the StreetEasy API?
The StreetEasy API covers active NYC rental listings across two endpoints — search_rentals and get_listing_details — returning over 15 fields per listing including address, price, bedroom count, bathrooms, building type, geo-coordinates, and broker information. Use search_rentals to filter the full inventory by neighborhood, price ceiling, bed count, and amenities, then pass any result's url_path to get_listing_details for photos, agent name, and a complete amenities list.
curl -X GET 'https://api.parse.bot/scraper/38049975-1a6c-4bcd-ad05-a4b1a051e522/search_rentals?page=1&areas=soho&sort_by=RECOMMENDED&max_beds=4&min_beds=2&per_page=5&amenities=elevator&max_price=30000&min_price=3000&sort_direction=ASCENDING' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace streeteasy-com-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
from parse_apis.streeteasy_rental_listings_api import StreetEasy, Sort, SortDirection, Areas, Amenities, NotFoundError
client = StreetEasy()
# Search for 2-bedroom rentals in Chelsea with elevator and doorman, sorted by price ascending
for listing in client.listings.search(
areas=Areas.CHELSEA,
min_beds=2,
max_beds=3,
max_price=15000,
amenities=Amenities.ELEVATOR,
sort_by=Sort.PRICE,
sort_direction=SortDirection.ASCENDING,
limit=5,
):
print(listing.address, listing.price, listing.bedrooms, listing.area, listing.living_area_sqft)
# Drill into a single result from a different neighborhood search
result = client.listings.search(
areas=Areas.SOHO,
min_price=5000,
max_price=30000,
limit=1,
).first()
if result:
print(result.street, result.unit, result.price, result.broker, result.building_type)
# Handle errors gracefully
try:
for listing in client.listings.search(areas=Areas.WILLIAMSBURG, min_beds=1, limit=3):
print(listing.address, listing.price, listing.full_bathrooms, listing.half_bathrooms)
except NotFoundError as exc:
print(f"No results: {exc}")
print("exercised: listings.search with areas/price/beds/amenities/sort filters")
Search for rental listings on StreetEasy with filters for bedrooms, price range, neighborhoods, and amenities. Returns a paginated list of matching active rental listings including address, price, size, broker info, and geo-coordinates. Pagination is manual via the page parameter; each page contains up to per_page results. Listings without a known square footage return living_area_sqft as null.
| Param | Type | Description |
|---|---|---|
| page | integer | Page number for pagination. |
| areas | string | Comma-separated neighborhood names or numeric area IDs. Supported names: soho, chelsea, west chelsea, tribeca, greenwich village, east village, west village, lower east side, upper east side, upper west side, midtown, midtown east, midtown west, financial district, battery park city, flatiron, gramercy park, murray hill, hell's kitchen, harlem, williamsburg, brooklyn heights, park slope, dumbo, long island city. Numeric area IDs also accepted (e.g. '107,115,163'). |
| sort_by | string | Sort attribute for results ordering. |
| max_beds | integer | Maximum number of bedrooms. If omitted, defaults to the value of min_beds. |
| min_beds | integer | Minimum number of bedrooms. |
| per_page | integer | Results per page. |
| amenities | string | Comma-separated amenities filter. Accepted values: elevator, doorman, laundry, gym, pool, parking, dishwasher, pets, outdoor_space, roof_deck. |
| max_price | integer | Maximum monthly rent in dollars. |
| min_price | integer | Minimum monthly rent in dollars. |
| sort_direction | string | Sort direction for results. |
{
"type": "object",
"fields": {
"page": "integer, current page number",
"listings": "array of listing objects with id, address, street, unit, area, price, bedrooms, full_bathrooms, half_bathrooms, building_type, status, broker, latitude, longitude, photo_url, url, url_path, living_area_sqft",
"per_page": "integer, results per page",
"total_count": "integer, total matching listings"
},
"sample": {
"data": {
"page": 1,
"listings": [
{
"id": "4808197",
"url": "https://streeteasy.com/building/the-chelsea/3n",
"area": "Chelsea",
"unit": "3N",
"price": 9544,
"broker": "Greystar",
"status": "ACTIVE",
"street": "160 West 24th Street",
"address": "160 West 24th Street #3N",
"bedrooms": 2,
"latitude": 40.7444,
"url_path": "/building/the-chelsea/3n",
"longitude": -73.9949,
"photo_url": "https://photos.zillowstatic.com/fp/9e966168fa0f43b7796e3c0e938bab1d-se_large_800_400.webp",
"building_type": "RENTAL",
"full_bathrooms": 2,
"half_bathrooms": 0,
"living_area_sqft": 948
}
],
"per_page": 3,
"total_count": 37
},
"status": "success"
}
}About the StreetEasy API
Searching Rental Listings
The search_rentals endpoint accepts filters for min_beds, max_beds, max_price, areas, and amenities. The areas parameter accepts either comma-separated neighborhood names (e.g., soho, tribeca, chelsea) or numeric area IDs. Amenity filters support values like elevator, doorman, laundry, gym, pool, and parking. Results are paginated — control page size with per_page and advance through results using the page parameter. The response includes total_count so you can calculate how many pages exist before fetching them.
Listing Response Shape
Each object in the listings array from search_rentals contains fields including id, address, street, unit, area, price, bedrooms, full_bathrooms, half_bathrooms, building_type, status, and a url_path used to fetch full details. Geographic coordinates are included, which makes the data usable for map-based display without a separate geocoding step.
Full Listing Details
get_listing_details takes a url_path from search results (e.g., /building/565-broome-soho/s23b) and returns a richer record: photos as an array of URLs, lead_photo, amenities as a string array, agent_name, broker, price, bedrooms, and the full listing url. Some fields such as address, amenities, and agent_name may be absent depending on the individual listing's data completeness.
Coverage and Scope
All listings reflect the active rental inventory on StreetEasy, which covers New York City apartments. There is no sales or mortgage data in this API. The sort_by parameter lets you order results by attributes such as price or listing date. Pagination is manual — the API does not auto-paginate, so iterating through total_count / per_page pages is the caller's responsibility.
The StreetEasy API is a managed, monitored endpoint for streeteasy.com — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when streeteasy.com changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official streeteasy.com API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build a neighborhood rent tracker by querying search_rentals with specific area IDs and recording price over time
- Power a map view of available NYC rentals using geo-coordinates returned in each listing object
- Filter doorman and elevator buildings in a price band using the amenities and max_price parameters
- Aggregate broker and agent names from get_listing_details to identify the most active rental agents by neighborhood
- Compare bedroom-to-price ratios across neighborhoods by running parallel search_rentals queries with different area values
- Build a listing alert tool by polling search_rentals for new listing IDs against a stored set
- Populate a rental comparison app with photos and full amenity lists from get_listing_details
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does StreetEasy have an official developer API?+
What neighborhood identifiers does the areas parameter accept?+
areas parameter in search_rentals accepts either comma-separated neighborhood name strings (e.g., soho, chelsea, west chelsea, tribeca) or numeric area IDs. Both formats filter results to listings within those neighborhoods. Mixing names and IDs in the same request is not documented as supported, so it's safest to use one format per call.Are for-sale listings or recently sold properties covered?+
search_rentals endpoint returns rentals with open status, and get_listing_details retrieves detail for rental records. Sales listings, sold history, and property valuation data are not covered. You can fork this API on Parse and revise it to add a sales search endpoint if that data is needed.What happens if a listing is missing fields like agent_name or amenities?+
get_listing_details response — including address, amenities, agent_name, and lead_photo — may be absent from the response object depending on what the listing contains. Your client code should handle missing keys gracefully rather than assuming all fields are always present.Is there a minimum price filter or a minimum bedrooms ceiling beyond what's documented?+
search_rentals endpoint exposes min_beds, max_beds, and max_price filters, but there is no documented min_price parameter. Filtering to a price floor is not currently supported in this API. You can fork the API on Parse and revise it to add a min_price parameter if your use case requires a price range rather than just a ceiling.