# Active Sales Search API

Our Sales Active Search API allows you to find properties that are currently listed for sale in specific NYC neighborhoods. By specifying a neighborhood, you can retrieve a curated list of properties that meet your search criteria. This endpoint supports various filters to help you narrow down the results, including property type (apartment, condo, house), price range, number of bedrooms and bathrooms, and more.  Checkout the table below for a list of supported filters and request parameters.

## Request

We provided the following filters to narrow down your active sales search

<table><thead><tr><th>Parameter</th><th width="286">Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td><code>areas</code></td><td>Comma separated list of NYC neighborhoods to filter for. Checkout below for a list of supported NYC neighborhoods</td><td>TRUE</td><td></td></tr><tr><td><code>minPrice</code></td><td>The minimum price of a property</td><td>FALSE</td><td>0</td></tr><tr><td><code>maxPrice</code></td><td>The maximum price of a property</td><td>FALSE</td><td>1,000,000,000</td></tr><tr><td><code>minBeds</code></td><td>The minimum number of beds of a property</td><td>FALSE</td><td>0</td></tr><tr><td><code>maxBeds</code></td><td>The maximum number of beds of a property</td><td>FALSE</td><td>10</td></tr><tr><td><code>minBaths</code></td><td>The minimum number of baths of a property</td><td>FALSE</td><td>0</td></tr><tr><td><code>maxHoa</code></td><td>The maximum monthly maintenance/hoa cost for the property</td><td>FALSE</td><td>1,000,000</td></tr><tr><td><code>maxTax</code></td><td>The maximum monthly tax cost for the property</td><td>FALSE</td><td>1,000,000</td></tr><tr><td><code>types</code></td><td>Comma separated list of property types to filter for.<br><code>condo</code>, <code>building</code>, <code>commercial</code>, <code>condop</code>, <code>house</code>, <code>multi_family</code>, <code>rental</code>,  <code>townhouse</code>,  <code>coop</code>, <code>house</code></td><td>FALSE</td><td>[]</td></tr><tr><td><code>amenities</code></td><td>Comma separated list of amenities to filter for.<br><code>washer_dryer</code>, <code>dishwasher</code>, <code>private_outdoor_space</code>, <code>laundry</code>, <code>elevator</code>, <code>doorman</code></td><td>FALSE</td><td>[]</td></tr><tr><td><code>limit</code></td><td>The number of records (page size) to return. Max value allowed is 500. <br>Use <code>offset</code> field to paginate through all records.</td><td>FALSE</td><td>100</td></tr><tr><td><code>offset</code></td><td>Offset to start fetching records from.</td><td>FALSE</td><td>0</td></tr></tbody></table>

#### NYC Supported Areas and Neighborhoods

<details>

<summary>Manhattan</summary>

* `roosevelt-island`
* `all-downtown`
  * `civic-center`
  * `financial-district`
    * `fultonseaport`
  * `tribeca`
  * `stuyvesant-townpcv`
  * `soho`
    * `hudson-square`
  * `little-italy`
  * `lower-east-side`
    * `two-bridges`
  * `chinatown`
  * `battery-park-city`
  * `gramercy-park`
  * `chelsea`
    * `west-chelsea`
  * `greenwich-village`
    * `noho`
  * `east-village`
  * `west-village`
  * `flatiron`
    * `nomad`
  * `nolita`
* `all-midtown`
  * `midtown`
  * `central-park-south`
  * `midtown-south`
  * `midtown-east`
    * `murray-hill`
    * `sutton-place`
    * `turtle-bay`
      * `beekman`
    * `kips-bay`
  * `midtown-west`
    * `hudson-yards`
    * `hells-kitchen`
* `all-upper-west-side`
  * `upper-west-side`
    * `lincoln-square`
    * `manhattan-valley`
* `all-upper-east-side`
  * `upper-east-side`
    * `lenox-hill`
    * `yorkville`
    * `carnegie-hill`
    * `upper-carnegie-hill`
* `all-upper-manhattan`
  * `morningside-heights`
  * `hamilton-heights`
  * `washington-heights`
    * `hudson-heights`
    * `fort-george`
  * `inwood`
  * `west-harlem`
    * `manhattanville`
  * `central-harlem`
    * `south-harlem`
  * `east-harlem`
  * `marble-hill`

</details>

<details>

<summary>Brooklyn</summary>

* `greenpoint`
* `williamsburg`
  * `east-williamsburg`
* `downtown-brooklyn`
* `fort-greene`
* `brooklyn-heights`
* `boerum-hill`
* `dumbo`
  * `vinegar-hill`
* `bedford-stuyvesant`
  * `stuyvesant-heights`
  * `ocean-hill`
* `bushwick`
* `east-new-york`
  * `new-lots`
  * `city-line`
  * `starrett-city`
  * `cypress-hills`
* `red-hook`
* `park-slope`
* `gowanus`
* `carroll-gardens`
* `cobble-hill`
* `sunset-park`
* `windsor-terrace`
* `crown-heights`
  * `weeksville`
* `prospect-heights`
* `columbia-st-waterfront-district`
* `prospect-lefferts-gardens`
* `bay-ridge`
  * `fort-hamilton`
* `dyker-heights`
* `bensonhurst`
* `bath-beach`
* `gravesend`
* `borough-park`
  * `mapleton`
* `ocean-parkway`
* `kensington`
* `coney-island`
* `brighton-beach`
* `ditmas-park`
  * `fiske-terrace`
* `seagate`
* `flatbush`
* `midwood`
* `sheepshead-bay`
  * `homecrest`
  * `madison`
* `manhattan-beach`
* `brownsville`
* `prospect-park-south`
* `east-flatbush`
  * `farragut`
  * `wingate`
* `canarsie`
* `flatlands`
* `marine-park`
* `mill-basin`
* `bergen-beach`
* `clinton-hill`
* `old-mill-basin`
* `greenwood`
* `gerritsen-bea`

</details>

<details>

<summary>Queens</summary>

* `astoria`
  * `ditmars-steinway`
* `long-island-city`
  * `hunters-point`
* `sunnyside`
* `woodside`
* `jackson-heights`
* `east-elmhurst`
* `north-corona`
* `elmhurst`
* `corona`
* `maspeth`
* `middle-village`
* `ridgewood`
* `glendale`
* `rego-park`
* `forest-hills`
* `flushing`
  * `east-flushing`
  * `murray-hill-queens`
* `whitestone`
  * `malba`
  * `beechhurst`
* `college-point`
* `fresh-meadows`
* `kew-gardens-hills`
* `jamaica-hills`
* `woodhaven`
* `richmond-hill`
* `kew-gardens`
* `howard-beach`
  * `hamilton-beach`
  * `ramblersville`
  * `rockwood-park`
  * `lindenwood`
  * `old-howard-beach`
* `ozone-park`
* `south-ozone-park`
* `bayside`
  * `bay-terrace-queens`
* `douglaston`
* `little-neck`
* `auburndale`
* `jamaica`
* `south-jamaica`
* `hollis`
* `st-albans`
* `laurelton`
* `cambria-heights`
* `queens-village`
* `glen-oaks`
* `floral-park`
* `bellerose`
* `rosedale`
* `springfield-gardens`
* `briarwood`
* `jamaica-estates`
* `new-hyde-park`
* `south-richmond-hill`
* `oakland-gardens`
* `hillcrest`
* `pomonok`
* `utopia`
* `clearview`
* `rockaway-all`
  * `far-rockaway`
  * `broad-channel`
  * `arverne`
  * `rockaway-park`
  * `bayswater`
  * `belle-harbor`
  * `breezy-point`
  * `neponsit`
  * `edgemere`
  * `hammels`
* `brookville`

</details>

<details>

<summary>Bronx</summary>

* `mott-haven`
  * `north-new-york`
* `melrose`
* `port-morris`
* `hunts-point`
* `longwood`
* `morrisania`
  * `claremont`
* `crotona-park-east`
* `highbridge`
* `concourse`
* `morris-heights`
* `university-heights`
* `fordham`
* `east-tremont`
  * `west-farms`
* `belmont`
* `bedford-park`
* `kingsbridge`
  * `kingsbridge-heights`
* `riverdale`
  * `fieldston`
  * `spuyten-duyvil`
* `soundview`
* `castle-hill`
* `parkchester`
* `throgs-neck`
  * `locust-point`
* `pelham-bay`
* `co-op-city`
* `city-island`
* `morris-park`
* `pelham-parkway`
* `van-nest`
* `laconia`
* `williamsbridge`
* `baychester`
* `woodlawn`
* `wakefield`
* `eastchester`
* `tremont`
  * `mt-hope`
* `norwood`
* `bronxwood`
* `pelham-gardens`
* `woodstock`
* `westchester-village`
  * `westchester-square`
* `country-club`
* `schuylerville`
* `edenwald`

</details>

<details>

<summary>Staten Island</summary>

* `north-shore`
  * `arlington`
  * `clifton`
  * `elm-park`
  * `grymes-hill`
  * `howland-hook`
  * `mariners-harbor`
  * `new-brighton`
  * `park-hill`
  * `port-richmond`
  * `rosebank`
  * `shore-acres`
  * `silver-lake`
  * `saint-george`
  * `stapleton`
  * `tompkinsville`
  * `west-brighton`
* `south-shore`
  * `annadale`
  * `arden-heights`
  * `charleston`
  * `eltingville`
  * `great-kills`
  * `greenridge`
  * `huguenot`
  * `pleasant-plains`
  * `princes-bay`
  * `richmond-valley`
  * `rossville`
  * `tottenville`
  * `woodrow`
* `east-shore`
  * `arrochar`
  * `bay-terrace`
  * `dongan-hills`
  * `egbertville`
  * `emerson-hill`
  * `fort-wadsworth`
  * `grant-city`
  * `grasmere`
  * `lighthouse-hill`
  * `midland-beach`
  * `new-dorp`
  * `oakwood`
  * `ocean-breeze`
  * `richmondtown`
  * `south-beach`
  * `todt-hill`
  * `new-dorp-beach`
  * `oakwood-beach`
* `west-shore`
  * `bloomfield`
  * `chelsea-staten-island`
  * `travis`
* `mid-island`
  * `bulls-head`
  * `castleton-corners`
  * `graniteville`
  * `manor-heights`
  * `meiers-corners`
  * `new-springville`
  * `sunnyside-staten-island`
  * `westerleigh`
  * `willowbrook`

</details>

<details>

<summary>New Jersey</summary>

* `cliffside-park`
* `edgewater`
* `fort-lee`
* `jersey-city`
  * `historic-downtown`
  * `waterfront`
    * `paulus-hook`
  * `the-heights`
  * `journal-square`
  * `mcginley-square`
  * `west-side`
  * `newport`
  * `bergenlafayette`
* `bayonne`
* `hoboken`
* `east-newark`
* `union-city`
* `north-bergen`
* `weehawken`
* `guttenberg`
* `harrison`
* `kearny`
* `secaucus`
* `west-new-yor`

</details>

#### Sample Request

```shell
curl --request GET \
	--url 'https://nyc-real-estate-api.p.rapidapi.com/sales/search?areas=all-downtown%2Call-midtown&minPrice=500000&maxPrice=5000000&minBeds=2&maxBeds=4&minBaths=1.5&limit=10' \
	--header 'x-rapidapi-host: streeteasy-api.p.rapidapi.com' \
	--header 'x-rapidapi-key: <radpid_api_key>'
```

## Response

An example response looks as follows:

```json
{
  "pagination": {
    "count": 1227,
    "nextOffset": 11
  },
  "listings": [
    {
      "id": "1750127",
      "price": 2680000,
      "status": "open",
      "longitude": -74.01360321,
      "latitude": 40.70740128,
      "url": "https://www.streeteasy.com/sale/1750127"
    },
    {
      "id": "1750118",
      "price": 2125000,
      "status": "open",
      "longitude": -74.01360321,
      "latitude": 40.70740128,
      "url": "https://www.streeteasy.com/sale/1750118"
    },
    {
      "id": "1750103",
      "price": 4795000,
      "status": "open",
      "longitude": -73.97090149,
      "latitude": 40.7478981,
      "url": "https://www.streeteasy.com/sale/1750103"
    },
    {
      "id": "1750076",
      "price": 1500000,
      "status": "open",
      "longitude": -73.98130035,
      "latitude": 40.76300049,
      "url": "https://www.streeteasy.com/sale/1750076"
    },
    {
      "id": "1750026",
      "price": 2799000,
      "status": "open",
      "longitude": -73.9910965,
      "latitude": 40.72660065,
      "url": "https://www.streeteasy.com/sale/1750026"
    },
    {
      "id": "1749986",
      "price": 2999000,
      "status": "open",
      "longitude": -74.01360321,
      "latitude": 40.70740128,
      "url": "https://www.streeteasy.com/sale/1749986"
    },
    {
      "id": "1749970",
      "price": 3600000,
      "status": "open",
      "longitude": -74.01280212,
      "latitude": 40.70909882,
      "url": "https://www.streeteasy.com/sale/1749970"
    },
    {
      "id": "1749962",
      "price": 3000000,
      "status": "open",
      "longitude": -74.01280212,
      "latitude": 40.70909882,
      "url": "https://www.streeteasy.com/sale/1749962"
    },
    {
      "id": "1749959",
      "price": 2875000,
      "status": "open",
      "longitude": -74.01280212,
      "latitude": 40.70909882,
      "url": "https://www.streeteasy.com/sale/1749959"
    },
    {
      "id": "1749957",
      "price": 2590000,
      "status": "open",
      "longitude": -74.01280212,
      "latitude": 40.70909882,
      "url": "https://www.streeteasy.com/sale/1749957"
    }
  ]
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://streasy.gitbook.io/search-api/sales-api/active-sales-search-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
