# Flatmates.com.au Scraper (`one-api/flatmates-scraper`) Actor Scrape Flatmates.com.au, Australia's #1 share-accommodation marketplace. Search rooms & whole properties, people looking, or team-ups by suburb/city/university/postcode or URL; get full listing details by id or URL, a member's listings, surrounding-suburb results, and location autocomplete. - **URL**: https://apify.com/one-api/flatmates-scraper.md - **Developed by:** [ONE API](https://apify.com/one-api) (community) - **Categories:** Lead generation, Real estate - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 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. 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 Scrape **Flatmates.com.au**, **Australia's #1 share-accommodation marketplace**. Search rooms & whole properties available, people looking for a place, or team-up groups by suburb / city / university / postcode (or a flatmates.com.au URL); look up full listing details by id or URL; pull a member's active listings, surrounding-suburb results, and resolve locations via autocomplete. ### What it does - **šŸ  Property Details** ā€” auto-detects each input as a listing id (`Pā€¦` room/property, `Fā€¦` person/team-up, or bare digits ā†’ `/details/byid`) or a flatmates.com.au URL (`/details/byurl`). Returns the full record: per-room rent, availability, preferences, photos, lister and map for rooms; budget, move date, professions and preferences for people / team-ups. - **šŸ”Ž Search Listings** ā€” auto-detects a free-text location (`/search/bylocation`) or a flatmates.com.au results URL (`/search/byurl`). The **Listing type** (rooms / people / team-ups) and all filters below apply. - **šŸŒ Surrounding Suburbs** ā€” listings in the suburbs *surrounding* a location (`/search/surrounding`), to widen a thin search. - **šŸ‘¤ Member Listings** ā€” a lister's currently active listings (`/member/listings`) from a `memberId`. - **šŸ” Location Autocomplete** ā€” resolve a suburb / city / university / postcode to the location key used by search (`/autocomplete`). - **šŸ“‹ Filters Reference** ā€” optional rows listing every accepted filter value and range (`/filters`). ### Output - **One flat dataset row per listing, member listing or location suggestion** ā€” sortable, filterable, CSV / Excel / JSON exportable. - Columns: `Mode`, `Input Given`, `Listing Kind`, `ID`, `Link`, `Title`, `Rent / Budget`, `Availability`, `Address`, `Suburb`, `City`, `State`, `Postcode`, `Bedrooms`, `Bathrooms`, `Occupants`, `Rooms Available`, `Age & Gender`, `Length of Stay`, `Property Type`, `Member ID`, `Lister Name`, `ID Verified`, `Latitude`, `Longitude`, `Cover Photo`, `Listing URL`. - The complete upstream JSON for each row is kept in the `Raw` column for power users. ### Inputs - Each section is independent ā€” fill only the ones you need; multiple inputs per section, one per line. - The Search filters (listing type, property/room/bathroom/furnishing/parking type, weekly rent / budget, bedrooms, gender, age, length of stay, keywords, sort, pages) apply to every location and URL search **and** to Surrounding Suburbs. - **Listing type** picks the axis: *rooms* (rooms & whole properties for rent), *people* (flatmates looking), or *team-ups* (groups looking together). Property-side filters apply to rooms; gender/age apply to people. ### Pricing - Pay per result: **$3 per 1,000 dataset items** ā€” the same rate on every Apify plan tier. - Apify start fee: $0.00005 per run. ### Notes - Flatmates serves roughly **12 listings per page** ā€” raise *Pages per search* to fetch more (there is no global total; paging stops when the upstream reports no next page). - This is **share accommodation** (rooms, flatmates, team-ups) in **Australia**, priced in **AUD per week** ā€” not a for-sale marketplace. - A `Member ID` from any detail row feeds the **Member Listings** section to pull everything that lister has posted. ### Errors - Failures land in the dataset as rows with `Mode = "ERROR"` and the upstream message in `Title` ā€” nothing is silently dropped. # Actor input Schema ## `property_inputs` (type: `array`): Auto-detects each entry and calls the right endpoint: ā€¢ A listing id ā€” `P1087596` (a room/property), `F3892184` (a person/team-up), or bare digits ā€” ā†’ `/details/byid` ā€¢ A `https://flatmates.com.au/...` listing URL ā†’ `/details/byurl` Each row = one full listing record: per-room rent, availability, preferences, photos, lister, map (for rooms/properties) or budget, move date, professions, preferences (for people/team-ups). ## `search_inputs` (type: `array`): Auto-detects each entry and routes to the right `/search/*` endpoint: ā€¢ A flatmates.com.au results URL, e.g. `https://flatmates.com.au/rooms/sydney` ā†’ `/search/byurl` ā€¢ Anything else ā€” a suburb, city, university or postcode, e.g. `Sydney`, `surry-hills-2010`, `unsw`, `2010` ā†’ `/search/bylocation` The filters below apply to every query. Each hit returns one row per listing. ## `searchType` (type: `string`): What to search for ā€” Flatmates' three listing axes. Applies to Search and Surrounding Suburbs. ## `propertyType` (type: `string`): Restrict room/property searches to a property type. Leave as Any for all. ## `roomType` (type: `string`): Private or shared room. ## `furnishingType` (type: `string`): Furnished or unfurnished room/property. ## `bathroomType` (type: `string`): Ensuite or own (private) bathroom. ## `parkingType` (type: `string`): Off-street, on-street, or no parking. ## `billsIncluded` (type: `boolean`): Only listings where bills are included in the rent. ## `budgetRange` (type: `string`): Weekly rent (rooms) or budget (people), e.g. `min:200,max:400` ā€” or just `min:200` / `max:400`. ## `numberOfBedroom` (type: `string`): Number of bedrooms in the property, e.g. `3`. ## `flatmateGenderType` (type: `string`): Gender filter for people / team-up searches. ## `ageRange` (type: `string`): Person age, e.g. `min:20,max:35`. ## `lengthOfStay` (type: `string`): Desired length of stay. ## `keywords` (type: `string`): Free-text keyword filter, e.g. `pet friendly`. ## `sort` (type: `string`): Result ordering. ## `pages` (type: `integer`): How many result pages to fetch for each Search / Surrounding query (~12 listings per page). ## `surrounding_inputs` (type: `array`): Find listings in the suburbs *surrounding* a location via `/search/surrounding` ā€” useful when an exact suburb is thin. Same listing type and filters as Search apply. One row per listing. ## `member_inputs` (type: `array`): A lister's currently active listings via `/member/listings`. A `memberId` comes from any listing detail's `Member ID` field. One row per listing. ## `autocomplete_inputs` (type: `array`): Resolve a suburb / city / university / postcode to the location key used by Search, via `/autocomplete`. Each suggestion = one row (key, type, title). ## `include_filters` (type: `boolean`): Add rows listing every accepted filter value and range (via `/filters`) ā€” handy for discovering valid inputs without trial and error. ## Actor input object example ```json { "property_inputs": [ "P1087596", "F3892184" ], "search_inputs": [ "Sydney" ], "searchType": "rooms", "propertyType": "any", "roomType": "any", "furnishingType": "any", "bathroomType": "any", "parkingType": "any", "billsIncluded": false, "budgetRange": "", "numberOfBedroom": "", "flatmateGenderType": "any", "ageRange": "", "lengthOfStay": "any", "keywords": "", "sort": "featured", "pages": 1, "surrounding_inputs": [], "member_inputs": [], "autocomplete_inputs": [ "bondi" ], "include_filters": false } ```` # 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 = { "property_inputs": [ "P1087596", "F3892184" ], "search_inputs": [ "Sydney" ], "surrounding_inputs": [], "member_inputs": [], "autocomplete_inputs": [ "bondi" ] }; // Run the Actor and wait for it to finish const run = await client.actor("one-api/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 = { "property_inputs": [ "P1087596", "F3892184", ], "search_inputs": ["Sydney"], "surrounding_inputs": [], "member_inputs": [], "autocomplete_inputs": ["bondi"], } # Run the Actor and wait for it to finish run = client.actor("one-api/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 '{ "property_inputs": [ "P1087596", "F3892184" ], "search_inputs": [ "Sydney" ], "surrounding_inputs": [], "member_inputs": [], "autocomplete_inputs": [ "bondi" ] }' | apify call one-api/flatmates-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=one-api/flatmates-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Flatmates.com.au Scraper", "description": "Scrape Flatmates.com.au, Australia's #1 share-accommodation marketplace. Search rooms & whole properties, people looking, or team-ups by suburb/city/university/postcode or URL; get full listing details by id or URL, a member's listings, surrounding-suburb results, and location autocomplete.", "version": "1.0", "x-build-id": "LbS11lpxYYA0VYr8w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~flatmates-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-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/one-api~flatmates-scraper/runs": { "post": { "operationId": "runs-sync-one-api-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/one-api~flatmates-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-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", "properties": { "property_inputs": { "title": "Listing id or flatmates.com.au URL (one per line)", "type": "array", "description": "Auto-detects each entry and calls the right endpoint:\nā€¢ A listing id ā€” `P1087596` (a room/property), `F3892184` (a person/team-up), or bare digits ā€” ā†’ `/details/byid`\nā€¢ A `https://flatmates.com.au/...` listing URL ā†’ `/details/byurl`\n\nEach row = one full listing record: per-room rent, availability, preferences, photos, lister, map (for rooms/properties) or budget, move date, professions, preferences (for people/team-ups).", "items": { "type": "string" } }, "search_inputs": { "title": "Location or search-results URL (one per line)", "type": "array", "description": "Auto-detects each entry and routes to the right `/search/*` endpoint:\nā€¢ A flatmates.com.au results URL, e.g. `https://flatmates.com.au/rooms/sydney` ā†’ `/search/byurl`\nā€¢ Anything else ā€” a suburb, city, university or postcode, e.g. `Sydney`, `surry-hills-2010`, `unsw`, `2010` ā†’ `/search/bylocation`\n\nThe filters below apply to every query. Each hit returns one row per listing.", "items": { "type": "string" } }, "searchType": { "title": "Listing type", "enum": [ "rooms", "people", "teamups" ], "type": "string", "description": "What to search for ā€” Flatmates' three listing axes. Applies to Search and Surrounding Suburbs.", "default": "rooms" }, "propertyType": { "title": "Property type (rooms only)", "enum": [ "any", "share_house", "whole_property", "studio", "one_bed", "granny_flat", "shared_room", "student_accommodation", "homestay" ], "type": "string", "description": "Restrict room/property searches to a property type. Leave as Any for all.", "default": "any" }, "roomType": { "title": "Room type (rooms only)", "enum": [ "any", "private_room", "shared_room" ], "type": "string", "description": "Private or shared room.", "default": "any" }, "furnishingType": { "title": "Furnishing (rooms only)", "enum": [ "any", "furnished", "unfurnished" ], "type": "string", "description": "Furnished or unfurnished room/property.", "default": "any" }, "bathroomType": { "title": "Bathroom (rooms only)", "enum": [ "any", "ensuite", "own" ], "type": "string", "description": "Ensuite or own (private) bathroom.", "default": "any" }, "parkingType": { "title": "Parking (rooms only)", "enum": [ "any", "off_street_parking", "on_street_parking", "no_parking" ], "type": "string", "description": "Off-street, on-street, or no parking.", "default": "any" }, "billsIncluded": { "title": "Bills included (rooms only)", "type": "boolean", "description": "Only listings where bills are included in the rent.", "default": false }, "budgetRange": { "title": "Weekly rent / budget (AUD)", "type": "string", "description": "Weekly rent (rooms) or budget (people), e.g. `min:200,max:400` ā€” or just `min:200` / `max:400`.", "default": "" }, "numberOfBedroom": { "title": "Bedrooms (rooms only)", "type": "string", "description": "Number of bedrooms in the property, e.g. `3`.", "default": "" }, "flatmateGenderType": { "title": "Gender (people only)", "enum": [ "any", "female", "male", "couples", "no_couples" ], "type": "string", "description": "Gender filter for people / team-up searches.", "default": "any" }, "ageRange": { "title": "Age range (people only)", "type": "string", "description": "Person age, e.g. `min:20,max:35`.", "default": "" }, "lengthOfStay": { "title": "Length of stay", "enum": [ "any", "one_week", "two_weeks", "four_weeks", "six_weeks", "two_months", "three_months", "four_months", "six_months", "nine_months", "one_year" ], "type": "string", "description": "Desired length of stay.", "default": "any" }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text keyword filter, e.g. `pet friendly`.", "default": "" }, "sort": { "title": "Sort order", "enum": [ "featured", "newest", "cheapest", "mostExpensive", "earliestAvailable", "moveEarliest", "lowestBudget", "recentlyActive" ], "type": "string", "description": "Result ordering.", "default": "featured" }, "pages": { "title": "Pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to fetch for each Search / Surrounding query (~12 listings per page).", "default": 1 }, "surrounding_inputs": { "title": "Location for surrounding-suburb search (one per line)", "type": "array", "description": "Find listings in the suburbs *surrounding* a location via `/search/surrounding` ā€” useful when an exact suburb is thin. Same listing type and filters as Search apply. One row per listing.", "items": { "type": "string" } }, "member_inputs": { "title": "Member id (one per line)", "type": "array", "description": "A lister's currently active listings via `/member/listings`. A `memberId` comes from any listing detail's `Member ID` field. One row per listing.", "items": { "type": "string" } }, "autocomplete_inputs": { "title": "Location text to resolve (one per line)", "type": "array", "description": "Resolve a suburb / city / university / postcode to the location key used by Search, via `/autocomplete`. Each suggestion = one row (key, type, title).", "items": { "type": "string" } }, "include_filters": { "title": "Include the filters reference", "type": "boolean", "description": "Add rows listing every accepted filter value and range (via `/filters`) ā€” handy for discovering valid inputs without trial and error.", "default": false } } }, "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 } } } } } } } } } } ```