{ "openapi": "3.0.1", "info": { "title": "Property Finder Scraper - Gulf Real Estate Listings", "description": "Export Property Finder listings across the UAE, Qatar, Bahrain, Egypt and Saudi Arabia: price, size, beds, coordinates, agent, brokerage, amenities and permit number.", "version": "1.0", "x-build-id": "HisXC0Jc5Pd8NMeXs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~property-finder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-property-finder-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/thirdwatch~property-finder-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-property-finder-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/thirdwatch~property-finder-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-property-finder-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", "required": [ "country", "purpose" ], "properties": { "country": { "title": "Country", "enum": [ "ae", "qa", "bh", "eg", "sa" ], "type": "string", "description": "Which Property Finder site to search.", "default": "ae" }, "purpose": { "title": "Listing type", "enum": [ "buy", "rent", "commercial-buy", "commercial-rent" ], "type": "string", "description": "Residential sale or rent, or the commercial equivalents.", "default": "buy" }, "locations": { "title": "Locations", "type": "array", "description": "Cities or communities, such as Dubai or Dubai Marina. Leave empty to search the whole country. Numeric Property Finder location ids also work.", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "default": [] }, "city": { "title": "City for community lookup", "type": "string", "description": "The city a community sits in, used to resolve names like Dubai Marina. Ignored for city-level searches.", "default": "Dubai" }, "searchUrls": { "title": "Property Finder search URLs", "type": "array", "description": "Paste any Property Finder search or location URL to reuse the exact filters you built in the browser.", "items": { "type": "string", "minLength": 10, "maxLength": 2000 }, "default": [] }, "propertyType": { "title": "Property type", "enum": [ "any", "apartment", "villa", "townhouse", "penthouse", "compound", "duplex", "full-floor", "half-floor", "whole-building", "land", "bulk-sale-unit", "bungalow", "hotel-apartment" ], "type": "string", "description": "Restrict to one property type.", "default": "any" }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Bedroom counts to include. 0 is studio, 8 means 7+.", "items": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8" ], "enumTitles": [ "Studio", "1", "2", "3", "4", "5", "6", "7", "7+" ] }, "default": [] }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Bathroom counts to include. 8 means 7+.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8" ], "enumTitles": [ "1", "2", "3", "4", "5", "6", "7", "7+" ] }, "default": [] }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "In the country's own currency. Rent prices are yearly." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "In the country's own currency. Rent prices are yearly." }, "minArea": { "title": "Minimum area", "minimum": 0, "type": "integer", "description": "Smallest floor area to include, in the unit that country's site uses: square feet in the Gulf, square metres in Saudi Arabia." }, "maxArea": { "title": "Maximum area", "minimum": 0, "type": "integer", "description": "Largest floor area to include, in the unit that country's site uses: square feet in the Gulf, square metres in Saudi Arabia." }, "furnished": { "title": "Furnishing", "enum": [ "any", "furnished", "unfurnished", "partly" ], "type": "string", "description": "Restrict to furnished, unfurnished, or partly furnished listings.", "default": "any" }, "completionStatus": { "title": "Completion status", "enum": [ "any", "ready", "off-plan" ], "type": "string", "description": "Restrict to ready properties or off-plan ones.", "default": "any" }, "listedWithin": { "title": "Listed within", "enum": [ "any", "1d", "7d", "15d", "30d", "90d" ], "type": "string", "description": "Only listings published in this window.", "default": "any" }, "verifiedOnly": { "title": "Verified listings only", "type": "boolean", "description": "Keep only listings Property Finder has verified.", "default": false }, "sort": { "title": "Sort by", "enum": [ "featured", "newest", "price-low", "price-high", "beds-least", "beds-most" ], "type": "string", "description": "Order the results the same way the site does.", "default": "featured" }, "maxResults": { "title": "Maximum listings", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Upper bound on saved listings across every location.", "default": 100 } } }, "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 } } } } } } } } } }