# Flatfox CH Properties and Details Scraper (`realestateapi/flatfox-ch-properties-and-details-scraper`) Actor

Policy-gated Flatfox CH real-estate listing Actor. It makes no source request by default; collection requires an explicit permission attestation and HTTPS Flatfox URLs. When permitted, it maps source-provided prices, property details, location, features, agencies, and media references.

- **URL**: https://apify.com/realestateapi/flatfox-ch-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

### What does the Flatfox CH Properties and Details Scraper do?

This Actor is a policy-gated connector for Swiss real-estate listings on [Flatfox.ch](https://flatfox.ch/). Flatfox's current General Terms and Conditions restrict broader platform use without a separate agreement and limit listing reuse to the advertiser and Flatfox. The Actor therefore makes **no source request or dataset write by default**; it stores the authorization-required diagnostic in `OUTPUT_SUMMARY` until the operator attests that written permission and applicable advertiser rights cover the requested access, extraction, and use.

When collection is permitted, the Actor accepts explicit HTTPS search or property URLs on `flatfox.ch` or `www.flatfox.ch`. It maps source-provided prices, sale or rental type, property category, location, room and floor details, areas, year built, availability, facilities, agency, image references, and media links when available. It does not follow redirects, configure a proxy, use a Flatfox account, or bypass access controls. The permission checkbox records the operator's statement; it does not grant permission.

### Why use this Actor?

If your permission allows this use, the normalized output can support research on Swiss sale and rental properties. Each normal result is a `flatfox-property` record with a listing identifier and official URL. Fields are omitted when Flatfox does not publish them; absent values are not guessed. Image references are source identifiers, not downloaded image files.

### How to use the Actor

1. Obtain written permission from Flatfox and confirm that the advertiser's rights cover the intended use.
2. Open the Input tab and add one or more explicit HTTPS Flatfox search or detail URLs.
3. Set `authorizationConfirmed` only when that permission applies, then choose the maximum number of records.
4. Run the Actor and inspect the dataset and `OUTPUT_SUMMARY` key-value record.
5. Export any permitted results in the format your workflow needs.

### Input

`authorizationConfirmed` defaults to `false`. If it is false or omitted, the Actor makes zero source requests and dataset writes, reports `SUCCEEDED` / `SKIPPED_POLICY`, and puts `AUTHORIZATION_REQUIRED` in the `OUTPUT_SUMMARY` KVS record. Setting it to true is an operator attestation only. `startUrls` then requires one to twenty explicit HTTPS URLs on the official Flatfox hosts; there is no default URL. `maxItems` limits unique property records and defaults to 10.

```json
{
  "authorizationConfirmed": false,
  "startUrls": [],
  "maxItems": 10
}
```

### Output

The dataset contains only listing-specific Flatfox property records with a numeric listing ID in the official property URL and at least one substantive property fact. Policy, empty-result, request, parse, and storage diagnostics stay in `OUTPUT_SUMMARY`; they are never dataset rows. An authorized run can emit more than 20 source-backed property fields plus a bounded `structuredData` object. The default no-request KVS summary looks like this:

```json
{
  "recordType": "flatfox-run-summary",
  "actorRank": 533,
  "actorName": "Flatfox CH Properties and Details Scraper",
  "actor": "flatfox-ch-properties-and-details-scraper",
  "source": "Flatfox.ch",
  "status": "SUCCEEDED",
  "runStatus": "SKIPPED_POLICY",
  "dataAvailable": false,
  "authorizationConfirmed": false,
  "requestedStartUrls": 0,
  "pagesVisited": 0,
  "records": 0,
  "requestCount": 0,
  "itemsStored": 0,
  "datasetItems": 0,
  "diagnosticsStored": 0,
  "diagnosticCount": 1,
  "diagnostics": [{
    "code": "AUTHORIZATION_REQUIRED",
    "message": "No source request was made. Applicable written permission and advertiser rights are not recorded.",
    "sourceUrl": "https://flatfox.ch/c/en/gtc/"
  }],
  "failureCount": 0,
  "failureDetails": [],
  "failedRequestCount": 0,
  "failedUrls": [],
  "blockedReasons": ["AUTHORIZATION_REQUIRED"],
  "maxItems": 10,
  "startedAt": "2026-09-29T00:00:00.000Z",
  "completedAt": "2026-09-29T00:00:00.000Z",
  "nativeExitCode": 0,
  "policyReason": "written_authorization_required"
}
```

You can download the dataset in formats such as JSON, CSV, Excel, and HTML through Apify's dataset interface. The `OUTPUT_SUMMARY` key-value record contains canonical status, counts, authorization state, and bounded diagnostic or failure details.

Clean bounded or empty runs report `SUCCEEDED` / `COMPLETED`. A failure with no saved property records reports `FAILED` / `FAILED` and exits with code 1. A later failure after saved property records reports `SUCCEEDED` / `PARTIAL` and exits successfully.

### Data table

| Field | Description |
|---|---|
| `title`, `description`, `officialUrl` | Public listing heading, description, and canonical page |
| `price`, `priceCurrency`, `priceUnit`, `offerType` | Sale/rent amount and type |
| `propertyType`, `rooms`, `floorNumber`, `livingAreaM2`, `yearBuilt` | Property details when present |
| `availability`, `availabilityType`, `availabilityDate` | Move-in information from the listing |
| `address`, `city`, `canton`, `postalCode`, `latitude`, `longitude` | Public listing location |
| `features`, `isFurnished`, `isTemporary` | Public amenities and rental attributes |
| `agency`, `imageIds`, `videoUrl`, `virtualTourUrl` | Advertiser and media references |
| `structuredData` | Bounded source-level public response |

### Pricing and cost estimation

Local runs use your machine. Apify-hosted runs consume resources according to your Apify account plan and run configuration; actual usage depends on how many listings you collect. A default policy-skipped run makes no source requests. Only start a collection run after confirming permission, then begin with a small `maxItems` value.

### Tips and advanced options

After authorization, use a direct property URL to validate one listing or an approved search URL to collect a permitted sample. Keep `maxItems` low while checking data quality. The Actor caps processing at 20 URLs per run and deduplicates repeated listings within the run. It does not download listing photographs; it returns image IDs and media links included in the source response.

### FAQ, disclaimers, and support

**Why is the Actor skipped?** The authorization checkbox is false by default. Obtain permission that covers the intended extraction and use before enabling it; the checkbox does not create an agreement.

**Why is a field missing?** The Actor omits values that are absent from a permitted source response and does not infer them.

**What if a request is blocked or redirected?** The Actor keeps safe failure details in `OUTPUT_SUMMARY`. It does not follow redirects, retry through another transport, or bypass access restrictions.

For an issue with the Actor, use the Apify Console's Issues tab and include a public listing URL and run ID. Do not include passwords, private contact details, or API credentials in an issue.

### Dependency maintenance

See [SECURITY_DEPENDENCIES.md](SECURITY_DEPENDENCIES.md) for the locked dependency remediation, the cache-disabled policy replacement, and offline regression coverage. Source permission/access prerequisites remain unchanged.

# Actor input Schema

## `startUrls` (type: `array`):

Explicit HTTPS Flatfox search or property detail URLs to inspect after confirming permission (up to 20). No URL is used by default.

## `authorizationConfirmed` (type: `boolean`):

Confirm only if written permission from Flatfox and applicable rights from the advertiser cover this access, extraction, and intended use. This checkbox does not grant permission.

## `maxItems` (type: `integer`):

Maximum number of unique public property listings to store.

## Actor input object example

```json
{
  "startUrls": [],
  "authorizationConfirmed": false,
  "maxItems": 10
}
```

# Actor output Schema

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

Dataset containing validated property listings only.

## `runSummary` (type: `string`):

The OUTPUT_SUMMARY key-value record with canonical status, counts, diagnostics, and failures.

# 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/flatfox-ch-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/flatfox-ch-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/flatfox-ch-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/flatfox-ch-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/EbXosIqEV8dy3Iewc/builds/t2qbUyFw03TRDfdEe/openapi.json