{ "openapi": "3.0.1", "info": { "title": "OpenSooq Scraper - Sale & Rent Property Listings", "description": "Extract OpenSooq property listings across 20 country markets, including prices, bedrooms, locations and photos. Choose sale or rent and pay per delivered listing row plus a start fee.", "version": "0.6", "x-build-id": "l6CZXAIrsul3JdeaJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~opensooq-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-opensooq-real-estate-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/lentic_clockss~opensooq-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-opensooq-real-estate-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/lentic_clockss~opensooq-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-opensooq-real-estate-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "OpenSooq property search or individual listing URLs. Each URL has its own maxItems allowance and takes precedence over generated market and category searches.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "market": { "title": "Market", "enum": [ "AE", "BH", "DZ", "EG", "IQ", "JO", "KW", "LB", "LY", "MA", "MR", "OM", "PS", "QA", "SA", "SD", "SY", "TN", "TR", "YE", "all" ], "type": "string", "description": "Country to search, or all for all 20 configured markets. A nonempty markets list takes precedence." }, "markets": { "title": "Markets", "type": "array", "description": "Countries to search instead of market. Each country has its own maxItems allowance, shared by its selected property categories.", "items": { "type": "string", "enum": [ "AE", "BH", "DZ", "EG", "IQ", "JO", "KW", "LB", "LY", "MA", "MR", "OM", "PS", "QA", "SA", "SD", "SY", "TN", "TR", "YE" ] } }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT" ], "type": "string", "description": "Choose BUY for properties for sale or RENT for rental listings.", "default": "BUY" }, "propertyType": { "title": "Property type", "enum": [ "all", "residential", "apartment", "villa", "townhouse", "whole-building", "farm-chalet", "foreign-property", "hotel-apartment", "shared-rooms", "commercial", "office", "shop", "complex", "showroom", "restaurant-cafe", "warehouse", "supermarket", "clinic", "commercial-villa", "full-floor", "hotel", "factory", "staff-housing", "land" ], "type": "string", "description": "Choose one property category, or all for the broad sale or rent category. hotel-apartment and shared-rooms are available only with RENT.", "default": "apartment" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Choose several property categories instead of propertyType. They share each market's maxItems allowance.", "items": { "type": "string", "enum": [ "all", "residential", "apartment", "villa", "townhouse", "whole-building", "farm-chalet", "foreign-property", "hotel-apartment", "shared-rooms", "commercial", "office", "shop", "complex", "showroom", "restaurant-cafe", "warehouse", "supermarket", "clinic", "commercial-villa", "full-floor", "hotel", "factory", "staff-housing", "land" ] }, "default": [] }, "expandAllCategories": { "title": "Expand all categories", "type": "boolean", "description": "When propertyType is all and propertyTypes is empty, search its supported categories separately. The categories still share each market's row allowance.", "default": false }, "location": { "title": "Location slug", "type": "string", "description": "City slug such as amman or dubai; leave empty for a national search. Do not combine location with postStatus sold." }, "locale": { "title": "Locale", "enum": [ "", "en", "ar" ], "type": "string", "description": "Choose English or Arabic for listing pages, or leave empty for the market default, English.", "default": "" }, "postStatus": { "title": "Listing status", "enum": [ "active", "sold" ], "type": "string", "description": "Choose active for current listings or sold for archived listings. Sold searches cannot be combined with location.", "default": "active" }, "maxItems": { "title": "Max listings per input", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum listing rows per start URL or market; default 70, with larger requests collected in parts of 70 and categories sharing each market's allowance. The run stops at your maximum total charge; Free-plan users are limited to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum search pages to read for each search URL. The run may stop sooner when the row allowance is reached.", "default": 1 }, "maxSearchUrls": { "title": "Max search URLs", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of searches generated from selected markets and property categories. Searches beyond this limit are not included.", "default": 60 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "Add available descriptions, attributes and advertiser information from listing detail pages. These fields remain in the same listing row.", "default": true }, "failOnPartial": { "title": "Fail on partial collection", "type": "boolean", "description": "Request failure when collection is flagged incomplete, rather than accepting a partial result. Leave false to allow available rows to be returned.", "default": false }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Pause between requests, in milliseconds. The Actor may wait longer when needed.", "default": 800 }, "maxConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Maximum number of listing detail pages requested at the same time.", "default": 2 }, "unlockerApiKey": { "title": "Developer test key", "type": "string", "description": "Leave empty. Used only by the developer for testing." }, "workerBaseUrl": { "title": "Developer test URL", "type": "string", "description": "Leave empty. Used only by the developer for testing." }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Alternative to maxItems; this value takes precedence when both are set. Each start URL or market receives this row allowance (default 70).", "default": 70 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }