# StreetEasy

Best for: New York City rentals and sales. Category: Property listings.

StreetEasy listings in one New York City area: rent or price and net-effective rent, beds, baths, size, address with coordinates, status, availability, photos and the listing link. One listing, one building or one agent profile in full.

- Look up by: An area slug or StreetEasy search link; a listing, building or agent profile URL
- Coverage: New York City. Rentals and sales, open or closed.
- Cost: From 2 credits a call; failed and empty calls are free
- Answers: Search, Prices, Details

## Endpoints

- `POST /v1/streeteasy/search`: StreetEasy rentals and sales, from 2 credits. https://scrapercompany.com/docs/reference/streeteasy-search
- `POST /v1/streeteasy/building`: StreetEasy building, 2 credits. https://scrapercompany.com/docs/reference/streeteasy-building
- `POST /v1/streeteasy/agent`: StreetEasy agent, 2 credits. https://scrapercompany.com/docs/reference/streeteasy-agent
- `POST /v1/streeteasy/listing`: StreetEasy listing, 2 credits. https://scrapercompany.com/docs/reference/streeteasy-listing

## Example

StreetEasy rentals and sales (`POST /v1/streeteasy/search`):

```bash
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
  }'
```

## Good to know

- 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.

## Guides

- [StreetEasy](https://scrapercompany.com/docs/guides/vertical-engines#streeteasy)

- [All data sources](https://scrapercompany.com/docs/data-sources)
