{ "openapi": "3.0.1", "info": { "title": "Bayut & PropertyFinder Scraper - Dubai & GCC Real Estate", "description": "Scrape live Bayut + PropertyFinder listings across the UAE & GCC: price, area, beds, agent, DLD permit, coordinates, images. Enriched with price-per-sqft, deal score vs community median, and days-on-market. One flat row per listing. CSV/JSON.", "version": "1.0", "x-build-id": "TXmTFAntrqapWrvzu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatalabs~bayut-propertyfinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatalabs-bayut-propertyfinder-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/webdatalabs~bayut-propertyfinder-scraper/runs": { "post": { "operationId": "runs-sync-webdatalabs-bayut-propertyfinder-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/webdatalabs~bayut-propertyfinder-scraper/run-sync": { "post": { "operationId": "run-sync-webdatalabs-bayut-propertyfinder-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": { "portals": { "title": "Portals", "type": "array", "description": "Which property portals to pull listings from.", "items": { "type": "string", "enum": [ "bayut", "propertyfinder" ], "enumTitles": [ "Bayut", "PropertyFinder" ] }, "default": [ "bayut", "propertyfinder" ] }, "location": { "title": "Location", "type": "string", "description": "City, community or area to search, e.g. \"Dubai Marina\", \"Business Bay\" or \"Dubai\". Leave empty if you paste search URLs below." }, "purpose": { "title": "Purpose", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy (for sale) or Rent.", "default": "buy" }, "propertyType": { "title": "Property type", "type": "array", "description": "Which property categories to include. Leave empty for all types.", "items": { "type": "string", "enum": [ "apartment", "villa", "townhouse", "penthouse", "commercial", "land" ], "enumTitles": [ "Apartment", "Villa", "Townhouse", "Penthouse", "Commercial", "Land / Plot" ] }, "default": [] }, "startUrls": { "title": "Search URLs (optional)", "type": "array", "description": "Power-user shortcut: paste one or more Bayut or PropertyFinder search-result URLs to copy their exact filters. Overrides Location.", "items": { "type": "string" } }, "maxResults": { "title": "Max listings", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Total listings to return across all selected portals. Keep low for a cheap trial run.", "default": 100 }, "trackHistory": { "title": "Track days-on-market & price changes", "type": "boolean", "description": "Persist a snapshot each run so scheduled runs report days-on-market, price changes, price history and a new-listing flag. Schedule the actor to build history over time.", "default": false }, "country": { "title": "Country", "enum": [ "AE", "SA", "QA", "BH", "EG" ], "type": "string", "description": "Which national market to search (selects the portal domains and currency).", "default": "AE" }, "priceMin": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum price in the market currency (e.g. AED). Leave empty for no minimum." }, "priceMax": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum price in the market currency. Leave empty for no maximum." }, "bedsMin": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum bedrooms (0 = studio). Leave empty for any." }, "bedsMax": { "title": "Max bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum bedrooms. Leave empty for any." }, "useApifyProxy": { "title": "Use Apify residential proxy", "type": "boolean", "description": "Required for reliable results. Both portals block datacenter/bare IPs; residential proxies rotate to avoid blocks.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify residential. Override the group/country here if needed.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxRetries": { "title": "Max retries per request", "minimum": 1, "maximum": 20, "type": "integer", "description": "Fresh-IP retries when a request is blocked or throttled.", "default": 8 }, "bayutAlgoliaKey": { "title": "Bayut Algolia key (optional)", "type": "string", "description": "Leave blank — a working public key is built in. Only paste a value here to self-heal if Bayut rotates its public search key before an updated build ships (copy the apiKey for appId LL8IZ711CS from bayut.com's JS bundle)." }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Verbose logs for blocks, rotations and parsing.", "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 } } } } } } } } } }