StreetEasy API
StreetEasy API for NYC rentals and sales
Pass a New York City area such as Brooklyn or Park Slope and get StreetEasy rentals or sales as JSON: price, net-effective rent, beds, baths, address, coordinates, photos and the listing link.
- Data from StreetEasy
$4.00 per 1,000 calls with a credit pack, down to $1.33 on the Business plan
7,500 credits, one-time. No subscription. Failed calls are free. The free trial covers the travel endpoints and 10 calls to the rest.
Endpoints and prices checked against the API on .
More real estate dataBrokers, investors and proptech teams watch StreetEasy to see what is for rent or for sale in New York, at what price, and which buildings and agents are behind the listings. StreetEasy does not offer an open API for reading that. This API reads the public pages and returns the numbers already parsed.
Search is one area at a time, rentals or sales, open or closed. One page is about 14 rentals or about 38 sales. Ask for up to 200 listings in one call and the API walks the pages from the first, charging only the pages it fetches. From a search row you can open the listing, its building, or an agent profile. The agent profile is the public page: name, brokerage and past deal counts, with no email or phone.
What you get
- price, net_effective_price
- the rent or price, and the net-effective rent when StreetEasy shows one
- street, unit, area_name, zip_code
- the address, unit, neighborhood and ZIP
- bedroom_count, full_bathroom_count, half_bathroom_count, living_area_sqft
- beds, baths and size
- latitude, longitude, url
- coordinates and the StreetEasy listing link
- status, available_at, months_free, lease_term_months
- listing status, availability and the free-rent terms on a rental
- photos
- the photos StreetEasy publishes for the listing
One call, structured JSON
POST /v1/streeteasy/search, from 2 credits per successful call.
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
}'{
"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
}
}Every field, documented before you buy
What one POST /v1/streeteasy/search call returns: 37 fields with their type and a value from the example above, then every input the call takes.
In the response
| Field | Type | Example | What it is |
|---|---|---|---|
| listings | array | ||
| listings[].id | string | "5149565" | The site’s own id for the item. |
| listings[].listing_type | string | "rent" | |
| listings[].url | string | "https://streeteasy.com/building/the-har…" | Address of the page the data came from. |
| listings[].url_path | string | "/building/the-hartby/c22" | |
| listings[].status | string | "ACTIVE" | |
| listings[].state | string | "NY" | |
| listings[].price | integer | 4845 | The price as the site shows it, in currency. |
| listings[].net_effective_price | integer | 4326 | |
| listings[].street | string | "788 Willoughby Avenue" | |
| listings[].unit | string | "#C22" | |
| listings[].area_name | string | "Stuyvesant Heights" |
Show all 37 fields
| listings[].zip_code | string | "11206" | |
| listings[].latitude | number | 40.694996 | Latitude in decimal degrees. |
| listings[].longitude | number | -73.93616 | Longitude in decimal degrees. |
| listings[].bedroom_count | integer | 2 | |
| listings[].full_bathroom_count | integer | 2 | |
| listings[].half_bathroom_count | integer | 0 | |
| listings[].living_area_sqft | integer | 0 | |
| listings[].building_type | string | "RENTAL" | |
| listings[].furnished | boolean | false | |
| listings[].months_free | number | 1.5 | |
| listings[].lease_term_months | integer | 14 | |
| listings[].available_at | string | "2027-02-11" | |
| listings[].is_new_development | boolean | false | |
| listings[].has_tour_3d | boolean | false | |
| listings[].has_videos | boolean | true | |
| listings[].media_asset_count | integer | 17 | |
| listings[].photos | array | ||
| listings[].source_group_label | string | "MNS" | |
| listings[].source_type | string | "PARTNER" | |
| total | integer | 3300 | Total for the whole stay or request, in currency. |
| page | integer | 1 | |
| total_pages | integer | 100 | |
| has_next_page | boolean | true | |
| criteria | string | "area:300|status:open" | |
| meta | object | About the call: what was asked for and how big the answer is. |
Arrays show their first item; every item has the same fields. Full schema in the API reference
In the request
| Input | Type | Required | What it does |
|---|---|---|---|
| mode | string | No | 'rent' for rentals, 'sale' for homes for sale.Default rent. |
| area | string | No | An area slug (brooklyn, park-slope) or a StreetEasy search link.Default brooklyn. Max length 300. |
| page | integer | No | Results page (StreetEasy caps at 100).Default 1. Min 1, max 100. |
| status | string | No | open (live) listings, or closed.Default open. |
| sort | string | null | No | StreetEasy sort name, e.g.Max length 41. |
| max_results | integer | null | No | Collect this many listings from page 1 onward (one upstream page per fetch: about 14 rentals or 38 sales).Min 1, max 200. |
Endpoints and price per call
Credits per successful call, and what 1,000 calls cost: from a credit pack down to the Business plan. Failed requests cost nothing.
| Endpoint | What it returns | Credits | Per 1,000 calls |
|---|---|---|---|
| Rentals or sales POST /v1/streeteasy/search | One page in an area, or up to 200 listings collected from page 1 | from 2 credits | from $4.00 – $1.33 |
| One listing POST /v1/streeteasy/listing | Price history, description, amenities, photos and the building | 2 credits | $4.00 – $1.33 |
| One building POST /v1/streeteasy/building | Year built, units, policies, availability by bedroom count and nearby schools | 2 credits | $4.00 – $1.33 |
| One agent POST /v1/streeteasy/agent | The public profile: brokerage, licence type, bio and past deal counts | 2 credits | $4.00 – $1.33 |
Your first call in three steps
- 01
Get an API key
Create an account and verify your email, then copy a key from the dashboard. The free trial is 50 calls or 14 days, whichever ends first, no card needed.
- 02
Send POST /v1/streeteasy/search
Put the key in the
x-api-keyheader. Every other input is optional and listed above. - 03
Read the JSON
The answer is one JSON object with
listings,total,page,total_pagesandhas_next_page, typed and named the same way on every call. A failed call costs 0 credits, so retrying is free.
Limits and coverage
- Where it works
- New York City. Rentals and sales, open or closed.
- Up to 100 pages deep (
page) - Up to 200 results per call (
max_results) - mode is rent or sale (default rent). area is a slug such as brooklyn or park-slope, or a StreetEasy search link (default brooklyn). status is open or closed (default open). sort is a StreetEasy sort name such as price_desc. page is 1 to 100.
- One page is about 14 rentals or about 38 sales. max_results, from 1 to 200, collects that many listings from page 1. A page other than 1 together with max_results is HTTP 422. A long collection can return truncated with the rows already fetched, and is charged only for the pages fetched.
- A listing URL is /building/<slug>/<unit>, or for a house or townhouse /building/<slug>/sale/<id> or /building/<slug>/rental/<id>. A building URL is /building/<slug>. An agent is /profile/<id> or the bare profile id. The agent profile has no email, phone or licence number.
- 2 credits per page or record. An empty page is free. A page past the last one, an unknown listing, building or profile is HTTP 404 and is free. A block before any page is fetched is HTTP 503 with Retry-After and is free. A mid-walk block returns the rows so far with truncated: true and bills pages_fetched.
Is it legal to scrape StreetEasy?
It depends on what you collect and what you do with it. Here is what the API does, and what stays with you once the data is yours.
Public pages only
The API reads what StreetEasy shows anyone who opens the page without signing in. It uses no account and opens nothing behind a paywall.
Facts are not the same as content
A price on a date, a rating or a count is a fact, and copyright does not protect facts. Review text, photos, descriptions and transcripts belong to their authors or the site. Counting, scoring or summarising them is a different use from republishing them, and republishing usually needs permission.
Databases have their own right in the EU and UK
Whoever invested in building a database there can stop others taking a substantial part of it, and repeated extraction of small parts can add up to a substantial part. Collect the fields and dates you need, not a copy of StreetEasy.
Personal data is yours to handle
Listings can name agents and brokers. If you keep it, the GDPR and UK GDPR apply to people in Europe and the UK, and other places have their own privacy laws: you need a lawful basis, must tell people you hold their data unless an exemption applies, should collect no more than you need, and should delete it on a schedule. The simplest route is not to keep it: drop names and handles before you store anything. A hashed name is still personal data.
The site’s terms, and ours
The terms of use of StreetEasy may limit automated access to it or reuse of its data. Our Terms make you responsible for how you use the data you collect, for following the terms of the sites it comes from, for data protection law, and for having the rights you need.
This is general information, not legal advice. For a specific use, ask a lawyer where you operate. StreetEasy is a trademark of its owner. ScraperCompany is independent: not affiliated with or endorsed by StreetEasy, and this is not an official StreetEasy API.
Frequently asked questions
Read next
Guides
Does StreetEasy have a public API?
Not for reading listings at large. ScraperCompany is independent of StreetEasy. This API reads StreetEasy’s public pages and needs no StreetEasy account.
How do I search rentals or sales?
Set mode to rent or sale, and area to a slug such as brooklyn or park-slope, or pass a StreetEasy search link. status is open or closed. sort takes a StreetEasy sort name such as price_desc. page runs from 1 to 100.
How many listings does one call return?
One page is about 14 rentals or about 38 sales. Set max_results from 1 to 200 to collect that many from page 1. That call reserves 2 credits for each page it may fetch and charges only the pages it fetches. A page other than 1 together with max_results is rejected.
What does an agent profile include?
Name, licence display type, brokerage, bio, profile URL and past sale and rental counts. Email, phone and the licence number are not on the public profile, so they are not returned.
Do failed requests cost credits?
No. A failed or blocked call (any 4xx or 5xx response) costs 0 credits, and so does a search page that comes back empty. You pay only for successful results.
How do I get an API key?
Create an account on the sign-up page and verify your email. You get a free trial of 50 calls or 14 days, whichever ends first, no card needed on the travel endpoints (hotels, vacation rentals, flights, reviews) and 10 calls to the other sources; for everything else, and after the trial, buy a credit pack (from $15) or pick a plan. You create and rotate keys yourself in the dashboard.
More APIs on the same key
All APIsPass a US place such as Chicago, IL, or a zillow.com search URL with your filters, and get one search page of homes for sale as JSON: price, address, beds, baths, square feet, year built, status, coordinates, photo and link.
Send a URL, get the page back as HTML, markdown or text. If an attempt does not return the page, the request is tried again automatically, and you pay only for a page that comes back with content.
Send a URL, get back an image of the page as a visitor sees it, after its JavaScript has run and its images have loaded. Pick the size, the format and what to capture: the viewport, the whole page or one element.
Look up any US tail number and get the FAA’s public record as JSON, or search the whole registry by owner, manufacturer, model, place or year: owner, airframe, engine and certificate dates, plus recent document receipts.
Start with 50 free calls
Create an account and verify your email: your own API keys and a free trial of 50 calls or 14 days, whichever ends first, no card needed. Then buy a credit pack from $15 or pick a plan from $49 a month.
7,500 credits, one-time. No subscription. Or try it free: 50 calls, no card.
- See pricingPlans, packs and every price
- Talk to salesVolume, custom terms, invoices
- Read the quickstartFirst call in five minutes