# Aqar Saudi Properties and Details Scraper (`realestateapi/aqar-sa-properties-and-details-scraper`) Actor

Aqar Saudi Properties and Details Scraper — Extracts source-backed listing fields only after written authorization and an explicit HTTPS Aqar URL are provided.

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

## Aqar Saudi Properties and Details Scraper

This Actor extracts source-backed Saudi property fields from `sa.aqar.fm`. It reads server-rendered `RealEstateListing` JSON-LD on an official listing or category page, then can fetch listing pages for detail JSON-LD. Aqar's platform terms require permission for collecting/reusing platform or user data; the Actor makes no source requests unless `authorizationConfirmed` is explicitly set to `true` after applicable written permission is confirmed.

### Input

- `startUrl`: an explicit HTTPS Aqar listing or category URL. There is no default source URL.
- `maxItems`: maximum unique properties, default `5`.
- `includeDetails`: fetch each public property page for richer source-backed fields, default `true`.
- `timeoutSecs`: direct request timeout, default `30`.
- `authorizationConfirmed`: set to `true` only when written permission covers automated collection and reuse of Aqar listing content. Defaults to `false`; otherwise the Actor completes as `SUCCEEDED` with `collectionStatus: SKIPPED_POLICY`, makes zero source requests, and emits no dataset rows. Redirects are refused and responses must remain on `https://sa.aqar.fm`.

### Output

The dataset contains only source-backed `property` records. Source and dataset failures never become diagnostic or placeholder rows. `OUTPUT_SUMMARY.status` is the operational status (`SUCCEEDED` or `FAILED`); `runStatus` and `collectionStatus` use `COMPLETED`, `PARTIAL`, `FAILED`, or `SKIPPED_POLICY`. Clean bounded or empty runs are `SUCCEEDED` / `COMPLETED`. A later failure after saving real property rows is `SUCCEEDED` / `PARTIAL`; a failure with no saved rows is `FAILED` / `FAILED` and exits nonzero. Missing written permission produces `SUCCEEDED` / `SKIPPED_POLICY`, zero requests, and a KVS-only diagnostic. Failure details stay in the aggregate KVS summary.

Only direct public HTTP requests to `sa.aqar.fm` are used. The actor does not call private APIs, log in, bypass access controls, or infer fields that are absent from the official JSON-LD.

### Local development

```text
npm install
apify validate-schema
npm run lint
apify run --input '{"maxItems":3,"authorizationConfirmed":false}'
npm test
```

Requests are sequential so each listing page can be checked against its source-backed detail record. Execution uses local Apify storage only.

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

## `startUrl` (type: `string`):

Explicit HTTPS listing or category URL on sa.aqar.fm. There is no default source URL.

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

Maximum unique property records returned from the listing page.

## `includeDetails` (type: `boolean`):

Fetch each public listing page and merge its source-backed description, price, room, address, geo and image fields.

## `timeoutSecs` (type: `integer`):

Timeout applied to each direct Aqar request.

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

Confirm written permission that covers automated collection and reuse of Aqar listing content. Without true, the Actor completes as SKIPPED_POLICY with no source requests or dataset rows.

## Actor input object example

```json
{
  "startUrl": "",
  "maxItems": 5,
  "includeDetails": true,
  "timeoutSecs": 30,
  "authorizationConfirmed": false
}
```

# 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 = {
    "maxItems": 5,
    "includeDetails": true,
    "timeoutSecs": 30,
    "authorizationConfirmed": false
};

// Run the Actor and wait for it to finish
const run = await client.actor("realestateapi/aqar-sa-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 = {
    "maxItems": 5,
    "includeDetails": True,
    "timeoutSecs": 30,
    "authorizationConfirmed": False,
}

# Run the Actor and wait for it to finish
run = client.actor("realestateapi/aqar-sa-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 '{
  "maxItems": 5,
  "includeDetails": true,
  "timeoutSecs": 30,
  "authorizationConfirmed": false
}' |
apify call realestateapi/aqar-sa-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/aqar-sa-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/to8DGaCnUfpxrYZ4T/builds/LkegCBa0fGvHkhLAN/openapi.json