# StreetEasy rentals and sales: `POST /v1/streeteasy/search`

Cost: from 2 credits (2 per page fetched (an empty page and a page past the last one are free). A block before any page is fetched is free. A mid-walk block returns the rows so far with `truncated: true` and bills `pages_fetched`. max_results reserves 2 per page it may fetch and charges only the pages fetched). Docs: https://scrapercompany.com/docs/reference/streeteasy-search

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

`max_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 body (JSON):

- `mode` (string; optional; default rent; one of rent, sale): 'rent' for rentals, 'sale' for homes for sale.
- `area` (string; optional; default brooklyn; max length 300): An area slug (brooklyn, park-slope) or a StreetEasy search link. NYC only.
- `page` (integer; optional; default 1; min 1, max 100): Results page (StreetEasy caps at 100). Leave this at 1 when max_results is set: that collection always starts at page 1.
- `status` (string; optional; default open; one of open, closed): open (live) listings, or closed.
- `sort` (string | null; optional; max length 41): StreetEasy sort name, e.g. price_desc.
- `max_results` (integer | null; optional; min 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.

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
