StreetEasy rentals and sales
mode is rent or sale (default rent). area is an area slug such as brooklyn or park-slope, or a StreetEasy search link, and is New York City only (default brooklyn). status is open or closed (default open). sort is a StreetEasy sort name such as price_desc. page is 1 to 100 (default 1); StreetEasy caps search at 100 pages. One upstream page is about 14 rentals or about 38 sales.
/v1/streeteasy/searchtruncated: true and bills pages_fetched. max_results reserves 2 per page it may fetch and charges only the pages fetchedmax_results (1 to 200) collects that many listings from page 1 onward in one call. It reserves 2 credits for each page it may have to fetch and charges only the pages it fetches. Set page to 1, or leave it unset, when max_results is set: any other page is HTTP 422. A walk that runs out of time, or is blocked after the first page, returns the rows so far with truncated: true and bills pages_fetched.
An empty page is HTTP 200 and is not charged. A page past the last one is HTTP 404 and is not charged. A block before any page is fetched is HTTP 503 with Retry-After and is not charged.
One page of StreetEasy listings in a New York City area.
Each listing carries rent (or price) and net-effective rent, beds, baths, size, full address with coordinates, status, availability, photos and the listing link to pass to /v1/streeteasy/listing. StreetEasy caps search at 100 pages (about 1,400 rentals or 3,800 sales); page through with page, narrow with area, status or sort, or set max_results to collect from page 1 (do not also set page). An empty page is not charged. A page past the last one is a 404 and is not charged. A block before any page is a 503 and is not charged. A max_results walk that runs out of time, or is blocked after the first page, returns the rows it has (truncated) and is charged only for the pages fetched.
Request
https://api.scrapercompany.com/v1/streeteasy/searchAuthenticate with your API key in the x-api-key header (see Authentication).
Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.
Body
JSON object. Unknown fields are rejected with 422.
- modestringdefault
rent'rent' for rentals, 'sale' for homes for sale.
One of
rentsale - areastringdefault
brooklynmax length 300An area slug (brooklyn, park-slope) or a StreetEasy search link. NYC only.
- pageintegerdefault
1min 1, max 100Results page (StreetEasy caps at 100). Leave this at 1 when max_results is set: that collection always starts at page 1.
- statusstringdefault
openopen (live) listings, or closed.
One of
openclosed - sortstring | nullmax length 41
StreetEasy sort name, e.g. price_desc.
- max_resultsinteger | nullmin 1, max 200
Collect this many listings from page 1 onward (one upstream page per fetch: about 14 rentals or 38 sales). Do not also set page.
Example request
curl -X POST "https://api.scrapercompany.com/v1/streeteasy/search" \
-H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"area": "brooklyn",
"mode": "rent",
"page": 1
}'Response
200 — Rentals in Brooklyn, page 1. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).
{
"search_parameters": {
"engine": "streeteasy_search",
"mode": "rent",
"area": "brooklyn",
"page": 1,
"status": "open"
},
"listings": [
{
"id": "5149565",
"listing_type": "rent",
"url": "https://streeteasy.com/building/the-hartby/c22",
"url_path": "/building/the-hartby/c22",
"status": "ACTIVE",
"state": "NY",
"price": 4845,
"net_effective_price": 4326,
"street": "788 Willoughby Avenue",
"unit": "#C22",
"area_name": "Stuyvesant Heights",
"zip_code": "11206",
"latitude": 40.694996,
"longitude": -73.93616,
"bedroom_count": 2,
"full_bathroom_count": 2,
"half_bathroom_count": 0,
"living_area_sqft": 0,
"building_type": "RENTAL",
"furnished": false,
"months_free": 1.5,
"lease_term_months": 14,
"available_at": "2027-02-11",
"is_new_development": false,
"has_tour_3d": false,
"has_videos": true,
"media_asset_count": 17,
"photos": [
{
"key": "ca16969fa53f202d3bf1be8ee7f5f44d",
"url": "https://photos.zillowstatic.com/fp/ca16969fa53f202d3bf1be8ee7f5f44d-p_e.webp",
"description": "788 Willoughby Avenue image 1 of 17"
}
],
"source_group_label": "MNS",
"source_type": "PARTNER"
}
],
"total": 3300,
"page": 1,
"total_pages": 100,
"has_next_page": true,
"criteria": "area:300|status:open",
"meta": {
"source": "streeteasy",
"elapsed_s": 0.42
}
}Errors
Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.
| Status | Meaning | Retry? |
|---|---|---|
401Unauthorized | Missing or invalid API key. {"detail":"missing or invalid API key"} | No, fix the request |
402Payment Required | Not enough credits for this request: the account's credits mode is {"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."} | No, fix the request |
404Not Found | The property, stay, job or record was not found. {"detail":"job not found"} | No, fix the request |
422Unprocessable Content | Request validation failed. {"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]} | No, fix the request |
429Too Many Requests | Too many requests: the key's requests-per-minute limit was exceeded, or (in {"detail":"rate limit 60/min exceeded"} | Yes, with backoff |
503Service Unavailable | Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. {"detail":"database unavailable: OperationalError"} | Yes, with backoff |
Try it
Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.
- Export your key:
export SCRAPERCOMPANY_API_KEY=sk_...(no key yet? start a free trial). - Copy the cURL example above and run it in a terminal.
Questions about this page?
Send the page link and your question, and the team will answer.