# StreetEasy Scraper (`jupri/streeteasy-scraper`) Actor 💫 All-In-One StreetEasy.com Scraper - **URL**: https://apify.com/jupri/streeteasy-scraper.md - **Developed by:** [cat](https://apify.com/jupri) (community) - **Categories:** Real estate, Travel - **Features:** Full permissions - **Stats:** 218 total users, 8 monthly users, 67.9% runs succeeded, 13 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage ## What's an Apify Actor? An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md. ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run. For examples already wired to this Actor's own input schema, see the [API](#api) section below. Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`). # README ## 💫 Welcome To StreetEasy Scraper ![don't be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png) ### 📌 About StreetEasy.com **StreetEasy** is a real estate listing and [technology company](https://en.wikipedia.org/wiki/Technology_company "Technology company"), launched in 2006, that operates in the [New York metropolitan area](https://en.wikipedia.org/wiki/New_York_metropolitan_area "New York metropolitan area"). Real estate listing information is provided via the website and mobile applications. StreetEasy was founded by Michael Smith, Sebastian Delmont, Doug Chertok, and [Nataly Kogan](https://en.wikipedia.org/wiki/Nataly_Kogan "Nataly Kogan") in 2005 as NMD Interactive.[\[1\]](https://en.wikipedia.org/wiki/StreetEasy#cite_note-1) The StreetEasy.com website launched in 2006. The company raised an initial $400k from investors including [Global Strategy Group](https://en.wikipedia.org/wiki/Global_Strategy_Group "Global Strategy Group"), Southpaw Capital Management and Sig Zises. The company received an additional $2.5M investment from FA Technology Ventures in 2006.[\[2\]](https://en.wikipedia.org/wiki/StreetEasy#cite_note-2) ### 📌 About This Actor 💫 All-In-One StreetEasy.com Scraper ### 📌 Basic Usage #### 🔎 Searching ***Search by location*** ```yaml { "search_type": "sale", "location": ["Bronx", "North Jersey"], "limit": 5 } ``` ***Search by address*** ```yaml { "search_type": "rent", "address": ["100 Claremont Avenue"], "limit": 5 } ``` ***Search by Keyword*** ```yaml { "query": ["big house"], "search_type": "rent", "limit": 5 } ``` ***Search by URL*** ```yaml { "query": ["https://streeteasy.com/for-sale/nyc/area:200?sort_by=listed_desc"], "limit": 5 } ``` #### 🔎 URL **Supported `URL` :** *`... almost there ...`* ### 📌 Advanced Usage *`... almost there ...`* ### 📌 Output Examples #### 🔎 Sale *`... almost there ...`* #### 🔎 Rental *`... almost there ...`* #### 🔎 Building *`... almost there ...`* #### 🔎 Profile (agent) *`... almost there ...`* #### 🔎 Additional Data **Listing Agents** *`... almost there ...`* **Property History** *`... almost there ...`* **Status Changes** *`... almost there ...`* **Upcoming Open House** *`... almost there ...`* **Building Available Units** *`... almost there ...`* **Building Unavailable Units** *`... almost there ...`* **Nearby Transits** *`... almost there ...`* ### 📌 Support ⚡️ Feel free to [reach out](https://console.apify.com/actors/gmZzlJm8uTN0xA5wD/issues) to the developer for any issues or suggestions for improvement. # Actor input Schema ## `query` (type: `array`): 💡 KEYWORDS or URL ## `search_type` (type: `string`): No description ## `limit` (type: `integer`): 💡 Limit number of results (max=1_000) ## `sort` (type: `string`): No description ## `include_description` (type: `boolean`): 💡 Listing and Building description ## `include_media` (type: `boolean`): 💡 Media: images, floorplans, videos, etc. ## `include_building` (type: `boolean`): No description ## `include_agents` (type: `boolean`): No description ## `include_history` (type: `boolean`): No description ## `include_changes` (type: `boolean`): No description ## `include_openhouse` (type: `boolean`): No description ## `include_available` (type: `boolean`): No description ## `include_unavailable` (type: `boolean`): No description ## `include_transits` (type: `boolean`): No description ## `location` (type: `array`): Acceptable Values :
  • AREA area or city
  • ZIPCODE numeric postal code

    • default: All New York City and New Jersey ## `address` (type: `array`): No description ## `transit` (type: `array`): No description ## `schools` (type: `array`): No description ## `sale_type` (type: `array`): No description ## `status` (type: `string`): default=open ## `owner_rental` (type: `boolean`): No description ## `min_movedate` (type: `string`): 💡 On or After (YYYY-MM-DD) ## `max_movedate` (type: `string`): 💡 On or Before (YYYY-MM-DD) ## `open_house` (type: `string`): in the next (X-1) days ## `video_tour` (type: `boolean`): No description ## `virtual_tour` (type: `boolean`): No description ## `building_type` (type: `array`): No description ## `min_year` (type: `integer`): No description ## `max_year` (type: `integer`): No description ## `pre_war` (type: `string`): 💡 Built before World War II, typically 1900–1939. ## `new_dev` (type: `string`): No description ## `income_restricted` (type: `string`): No description ## `min_bedrooms` (type: `integer`): No description ## `max_bedrooms` (type: `integer`): No description ## `studio` (type: `boolean`): No description ## `min_bathrooms` (type: `string`): No description ## `min_size` (type: `integer`): No description ## `max_size` (type: `integer`): No description ## `min_price` (type: `integer`): No description ## `max_price` (type: `integer`): No description ## `min_pps` (type: `integer`): No description ## `max_pps` (type: `integer`): No description ## `no_pps` (type: `boolean`): No description ## `min_fee` (type: `integer`): No description ## `max_fee` (type: `integer`): No description ## `min_taxes` (type: `integer`): No description ## `max_taxes` (type: `integer`): No description ## `pet_allowed` (type: `boolean`): No description ## `amenities` (type: `array`): No description ## `optional` (type: `array`): No description ## `dev_custom_headers` (type: `array`): 💡 Additional HTTP Headers ## `dev_custom_cookies` (type: `array`): 💡 Additional HTTP Cookies ## `dev_transform_fields` (type: `array`): 💡 Transform the resulting output. Select only needed fields.

    For nested object use DOT. For example: 
    address.streetAddress

    For nested array use NUMBER (index of array element starting from index=0). For example: 
    images.0.url
    ## `dev_dataset_name` (type: `string`): 💡 Save results into custom named Dataset, use mask to customize dataset name

    {ACTOR} = actor name
    {DATE} = date (YYYYMMDD)
    {TIME} = time (HHMMSS)

    This masks can be used to autogenerate Dataset Name.

    example: data-{DATE}
    Depending on today date the dataset name will be: data-20230603

    default: data-{ACTOR}-{DATE}-{TIME}     ## `dev_dataset_clear` (type: `boolean`): Clear Dataset before insert/update. ## `dev_no_strip` (type: `boolean`): 💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING) ## `dev_fileupload` (type: `string`): 💡 Upload your file and copy & paste the URL somewhere. ## Actor input object example ```json { "search_type": "sale", "limit": 5 } ``` # Actor output Schema ## `results` (type: `string`): No description ## `mapViewer` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "limit": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("jupri/streeteasy-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "limit": 5 } # Run the Actor and wait for it to finish run = client.actor("jupri/streeteasy-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}") for item in client.dataset(run.default_dataset_id).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "limit": 5 }' | apify call jupri/streeteasy-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "type": "http", "url": "https://mcp.apify.com/?tools=fetch-actor-details,jupri/streeteasy-scraper" } } } ``` The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations). ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/gmZzlJm8uTN0xA5wD/builds/0CUplnC3S02heTlOW/openapi.json