# Flatmates Scraper (`azzouzana/flatmates-scraper`) Actor From $0.7/1K ๐Ÿ’ฐScrape rooms, people & teamups from Flatmates.com.au! ๐Ÿ  Australia's #1 share accommodation site. Extract listings fast & easy ๐Ÿš€ - **URL**: https://apify.com/azzouzana/flatmates-scraper.md - **Developed by:** [Azzouzana](https://apify.com/azzouzana) (community) - **Categories:** Travel, Real estate, Automation - **Stats:** 19 total users, 5 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: No ratings yet ## Pricing from $0.70 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. Actors are written with capital "A". ## 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. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## ๐Ÿ  Flatmates.com.au Scraper **Unlock the potential of Australia's #1 share accommodation site!** ๐Ÿš€ This powerful actor scrapes data from [Flatmates.com.au](https://flatmates.com.au/), extracting detailed information about **rooms** ๐Ÿ›๏ธ, **people** ๐Ÿ‘ค, and **teamups** ๐Ÿค. --- ### โš™๏ธ Input Configuration The actor accepts the following input options: - `startUrl` ๐Ÿ”—: The URL to start scraping from (e.g., search results page). This should be either a people, rooms, or teamups search results page URL. Example of these are - `https://flatmates.com.au/rooms/campsie-2194?search_source=search_function` - `https://flatmates.com.au/people/sydney/max-8-weeks?search_source=search_function` - `https://flatmates.com.au/teamups/campsie-2194?search_source=search_function` - `maxItems` ๐Ÿ“„: Maximum number of items to scrape (default 1000). ### ๐Ÿ“ค Output The result is stored in the default dataset containing detailed listing data, ready for your analysis! ๐Ÿ“Š ### ๐Ÿ†“ Free tier limitations We want you to see how this actor works before you commit. To keep things fair for everyone, the **free tier** usually includes these trial limits: - **Sample data:** up to **5 listings** per runโ€”enough to check data quality. - **Daily cap:** **5 runs** per calendar day (UTC). - **Between runs:** at least **30 minutes** before you can start another run. > Limits can change with platform load depending on system load and your intended scraping to prevent what we might interpret as free users abuse. #### Upgrade when you're ready! Use the free tier to decide if this actor fits your project. Paid Apify plans remove these wait times and caps so you can run at full volumeโ€”[**upgrade to a paid plan**](https://apify.com/pricing?fpr=cbgdsf). #### ๐Ÿ—๏ธ SEO Keywords Flatmates Scraper, Real Estate Australia, Room Share Data, Flatshare Listings, Australia Accommodation Scraper, Apify Flatmates Actor, Housing Data Australia, Roommate Finder Australia. #### ๐Ÿ“ฌ Contact & Custom Solutions **Need something specific?** Want to chat? Don't hesitate to reach out to us! ๐Ÿ’ฌ - **Discord**: `@azzouzana` ๐ŸŽฎ - **Email**: `labs@azzouzana.com` ๐Ÿ“ง # Actor input Schema ## `startUrl` (type: `string`): Search results page URL ## `maxItems` (type: `integer`): Maximum number of listings to scrape ## Actor input object example ```json { "startUrl": "https://flatmates.com.au/rooms/campsie-2194/1-week?search_source=search_function", "maxItems": 1000 } ```` # 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 = { "startUrl": "https://flatmates.com.au/rooms/campsie-2194/1-week?search_source=search_function", "maxItems": 1000 }; // Run the Actor and wait for it to finish const run = await client.actor("azzouzana/flatmates-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 = { "startUrl": "https://flatmates.com.au/rooms/campsie-2194/1-week?search_source=search_function", "maxItems": 1000, } # Run the Actor and wait for it to finish run = client.actor("azzouzana/flatmates-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("๐Ÿ’พ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # ๐Ÿ“š Want to learn more ๐Ÿ“–? Go to โ†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "startUrl": "https://flatmates.com.au/rooms/campsie-2194/1-week?search_source=search_function", "maxItems": 1000 }' | apify call azzouzana/flatmates-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=azzouzana/flatmates-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Flatmates Scraper", "description": "From $0.7/1K ๐Ÿ’ฐScrape rooms, people & teamups from Flatmates.com.au! ๐Ÿ  Australia's #1 share accommodation site. Extract listings fast & easy ๐Ÿš€", "version": "0.0", "x-build-id": "3mM1LkzIZNER6F4hU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/azzouzana~flatmates-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-azzouzana-flatmates-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/azzouzana~flatmates-scraper/runs": { "post": { "operationId": "runs-sync-azzouzana-flatmates-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/azzouzana~flatmates-scraper/run-sync": { "post": { "operationId": "run-sync-azzouzana-flatmates-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "startUrl" ], "properties": { "startUrl": { "title": "Search results page URL", "pattern": "^https://flatmates.com.au/", "type": "string", "description": "Search results page URL" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum number of listings to scrape", "default": 1000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```