# Flatmates Properties and Details Scraper (`realestateapi/flatmates-properties-and-details-scraper`) Actor

Process Flatmates listing pages only with express written permission. Requests are disabled by default and restricted to HTTPS Flatmates hosts.

- **URL**: https://apify.com/realestateapi/flatmates-properties-and-details-scraper.md
- **Developed by:** [Real Estate API](https://apify.com/realestateapi) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.99 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## 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

## Flatmates Properties and Details Scraper

Flatmates' [Terms and Conditions of Use](https://flatmates.com.au/info/terms), section 3.1(q), prohibit screen scraping, database scraping, and collecting user lists or other data. Section 6 limits use of website content to the terms or express written authorization.

This Actor makes no source requests by default. Set `contentUseAuthorized` to `true` only after obtaining express written permission covering automated extraction and the intended use. The Actor accepts explicit HTTPS URLs on `flatmates.com.au` or `www.flatmates.com.au` only and refuses redirects. This field is an operator attestation; it does not grant permission.

When properly authorized, the parser reads supported structured property-listing data, deduplicates listing URLs, and writes a `SUMMARY` key-value record. Dataset items contain validated property listings only. Policy notes, empty-result notes, and failure details are written to the summary, never as dataset rows. Missing or ranged prices are omitted rather than converted into a guessed value.

Run summaries use `status: SUCCEEDED` with `runStatus: COMPLETED` for clean bounded or empty processing, `SUCCEEDED/PARTIAL` when failures occur after real records are saved, `FAILED/FAILED` when failures occur before any real record is saved, and `SUCCEEDED/SKIPPED_POLICY` when the default authorization gate prevents requests. A zero-row failure sets the process exit code to 1; successful, partial, and policy-skipped runs exit 0.

For offline checks, run `npm test`, `npm run lint`, `npm run validate-datasets`, and `apify validate-schema`. Do not run this Actor against Flatmates unless the site's terms change or express written permission is obtained.

### Runtime security and HTTP caching

The October 3, 2026 dependency remediation updates compatible runtime packages and uses patched `basic-ftp` 6.2.1. The unpatched `http-cache-semantics` dependency is explicitly replaced by the independently authored adapter in `vendor/no-cache-policy`. This disables HTTP response caching and cached-response revalidation, including reuse of old cached bodies or cookies. It is not an upstream security patch or a renamed upstream version. Requests always reach the origin; source gates and finite request limits still apply. Offline integration tests exercise real `got` caching and the `get-uri` FTP interface. See the adapter README for its interface and limitations.

# Actor input Schema

## `urls` (type: `array`):

Flatmates URLs to process only with express written permission covering automated extraction and the intended use. Only HTTPS flatmates.com.au hosts are accepted.

## `contentUseAuthorized` (type: `boolean`):

Set true only if you have express written permission from Flatmates.com.au covering automated extraction and the intended use. The Terms prohibit screen scraping, database scraping, and obtaining lists of users or other data. No requests are made when false.

## `maxPages` (type: `integer`):

Maximum supplied URLs to request; this setting does not paginate search results.

## Actor input object example

```json
{
  "urls": [],
  "contentUseAuthorized": false,
  "maxPages": 10
}
```

# Actor output Schema

## `dataset` (type: `string`):

No description

## `summary` (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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("realestateapi/flatmates-properties-and-details-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("realestateapi/flatmates-properties-and-details-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 '{}' |
apify call realestateapi/flatmates-properties-and-details-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,realestateapi/flatmates-properties-and-details-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 <APIFY_API_TOKEN>` 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/I3IeRPzELSkrqZNUs/builds/JqMNxbBLVuRMOf2f4/openapi.json