# Compass Properties and Details Scraper (`realestateapi/compass-properties-and-details-scraper`) Actor

Process Compass property pages only with express written authorization. Requests are disabled by default and restricted to HTTPS Compass hosts.

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

## Compass Properties and Details Scraper

This Actor processes Compass property pages only when Compass has expressly authorized automated collection and the intended use in writing. Compass's [Terms of Service](https://www.compass.com/legal/terms-of-service/) prohibit crawling, spidering, scraping, and harvesting Content; they also limit ordinary use of Content to personal, non-commercial purposes. The current workspace has no recorded written authorization.

The Actor makes no source requests by default. Set `contentUseAuthorized` to `true` only after confirming that written authorization covers this automated use. This is an operator attestation; it does not grant permission. The Actor accepts explicit HTTPS URLs on `compass.com` or `www.compass.com`, refuses redirects, applies a 15-second request timeout and a 5 MiB response limit, and processes only the provided URLs. It does not discover or paginate search results.

For an authorized page, the current parser reads supported property facts from Schema.org JSON-LD and emits a row only when it finds a canonical Compass URL and at least one property fact. The dataset fields are `recordType`, `listingId`, `address`, `price`, `beds`, `baths`, `propertyType`, `url`, `sourceUrl`, and `scrapedAt`; absent values are omitted. A URL or identifier alone is not enough to create a record. Parser tests use synthetic data and do not establish current Compass extraction.

The default policy skip reports `status: SUCCEEDED` and `runStatus: SKIPPED_POLICY`, with zero stored items. A valid empty result is `SUCCEEDED / COMPLETED`; a failure with zero stored records is `FAILED / FAILED`; a failure after one or more records were stored is `SUCCEEDED / PARTIAL`. Failure codes and counts stay in the `SUMMARY` key-value record. The Actor does not bypass access controls, bot challenges, or other restrictions.

#### Dependency security

The locked dependency graph overrides basic-ftp with the patched 6.2.1 release. The SDK’s unpatched HTTP cache policy is replaced with the readable local vendor/noncaching-http-policy adapter, which refuses cache reads and writes and forces fresh network responses. This is an explicit removal of caching, not a claimed upstream security patch. Source transports, permission gates and request limits are unchanged. npm run test:dependencies checks cross-user cache isolation, imported stale policy rejection, FTP integration methods and adversarial listing parsing. Cloud builds run npm audit --omit=dev --audit-level=low against the installed production graph.

# Actor input Schema

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

Compass URLs to process only when Compass has expressly authorized this automated use in writing. Only HTTPS compass.com and www.compass.com URLs are accepted.

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

Set true only if you have express written authorization from Compass covering automated collection and your intended use. Compass Terms otherwise prohibit crawling, scraping, and harvesting. No requests are made when false.

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

Maximum number of explicitly supplied Compass URLs to process. This does not discover or paginate additional pages.

## Actor input object example

```json
{
  "startUrls": [],
  "contentUseAuthorized": false,
  "maxPages": 3
}
```

# 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/compass-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/compass-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/compass-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/compass-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/3FFrotAHppImbDl7J/builds/gyXxkq7vkBBqcmQ7W/openapi.json