{ "openapi": "3.0.1", "info": { "title": "OpenSooq Scraper السوق المفتوح: MENA Data API", "description": "Scrape OpenSooq السوق المفتوح listings, Saudi used cars, and MENA real estate. Export prices, specifications, locations, and images to Sheets, databases, or APIs. No login. $0.89 per 1,000 results on the Free tier.", "version": "0.1", "x-build-id": "FSWLhrrj9jftQGjnv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~opensooq-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-opensooq-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/getascraper~opensooq-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-opensooq-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/getascraper~opensooq-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-opensooq-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": [ "site", "maxItems", "proxyConfiguration" ], "properties": { "site": { "title": "Country Site", "enum": [ "jo", "sa", "ae", "kw", "bh", "om", "qa", "iq", "eg", "ye", "ly", "sd", "lb", "ps", "sy", "dz", "ma", "tn", "tr", "mr" ], "type": "string", "description": "Select which OpenSooq country site to scrape.", "default": "sa" }, "query": { "title": "Search Query", "type": "string", "description": "Optional keyword (for example, 'toyota' or 'شقة'). It can be combined with a guided vertical, or left empty to browse that vertical.", "default": "iphone" }, "queries": { "title": "Bulk Search Queries", "type": "array", "description": "Paste multiple keywords to search and scrape simultaneously in a single bulk run.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "startUrls": { "title": "Exact OpenSooq Search URLs", "type": "array", "description": "Optional exact OpenSooq search URLs. When supplied, these URLs take absolute precedence; all guided fields are ignored so every source filter is preserved.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "vertical": { "title": "Guided Vertical", "enum": [ "general", "cars_for_sale", "apartments_for_sale", "apartments_for_rent" ], "type": "string", "description": "Choose a source-validated Saudi vehicle or apartment route, or keep General Search. Guided verticals currently require Country Site = Saudi Arabia (sa).", "default": "general" }, "category": { "title": "Category", "enum": [ "", "1729", "5501", "1941", "13723", "1929", "7569", "7873", "1979", "54971", "54973", "6961", "24", "15963", "3037", "15043", "15083", "4871" ], "type": "string", "description": "Optional category for General Search. Do not combine this with a Guided Vertical.", "default": "" }, "city": { "title": "City ID", "type": "string", "description": "Optional numeric OpenSooq city ID. Saudi Riyadh is 24. For city names or URL slugs, use Exact OpenSooq Search URLs.", "default": "" }, "neighborhood": { "title": "Neighborhood ID", "type": "string", "description": "Optional numeric OpenSooq neighborhood ID. Requires City ID. Use an exact URL when you only know the neighborhood name.", "default": "" }, "priceFrom": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Only return listings priced at or above this value. Leave empty for no minimum." }, "priceTo": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Only return listings priced at or below this value. Leave empty for no maximum." }, "vehicleYearFrom": { "title": "Minimum Model Year", "minimum": 1970, "type": "integer", "description": "Cars for Sale only. Earliest model year to include." }, "vehicleYearTo": { "title": "Maximum Model Year", "minimum": 1970, "type": "integer", "description": "Cars for Sale only. Latest model year to include." }, "vehicleMileageBand": { "title": "Mileage Band", "enum": [ "", "7364", "19889", "4599", "4601", "4603", "4605", "4607", "4609", "4611", "4613", "4615", "4617", "4619", "4621", "4623", "4625", "4627", "4629", "4631", "4633", "4635", "4637", "4639" ], "type": "string", "description": "Cars for Sale only. OpenSooq exposes mileage as source-defined bands rather than an arbitrary numeric range.", "default": "" }, "propertyBedrooms": { "title": "Bedrooms", "enum": [ "", "6195", "2477", "2479", "2481", "2483", "2485", "2487" ], "type": "string", "description": "Apartment verticals only. Select one OpenSooq bedroom option.", "default": "" }, "propertyBathrooms": { "title": "Bathrooms", "enum": [ "", "2515", "2517", "2519", "2521", "2523", "23256" ], "type": "string", "description": "Apartment verticals only. Select one OpenSooq bathroom option.", "default": "" }, "surfaceFrom": { "title": "Minimum Surface (m²)", "minimum": 0, "type": "integer", "description": "Apartment verticals only. Minimum property surface in square metres." }, "surfaceTo": { "title": "Maximum Surface (m²)", "minimum": 0, "type": "integer", "description": "Apartment verticals only. Maximum property surface in square metres." }, "sortBy": { "title": "Sort Order", "enum": [ "recent", "default", "price-", "price+", "Car_Year-", "Car_Year+", "Kilometers_Cars-", "Kilometers_Cars+", "Rooms-", "Rooms+", "Surface-", "Surface+" ], "type": "string", "description": "Order results using OpenSooq's sort codes. Vehicle- and property-specific sorts require the matching Guided Vertical.", "default": "recent" }, "hasImages": { "title": "Only with Images", "type": "boolean", "description": "Only return listings containing image galleries.", "default": false }, "hasPrice": { "title": "Only with listed Price", "type": "boolean", "description": "Only return listings that disclose an explicit price.", "default": false }, "isShop": { "title": "Only Business Shops", "type": "boolean", "description": "Only return listings posted by registered business shops.", "default": false }, "unmaskPhones": { "title": "Auto-Unmask Phone Numbers", "type": "boolean", "description": "Attempt to unmask and extract complete mobile phone numbers for leads generation.", "default": false }, "accessToken": { "title": "OpenSooq Access Token (JWT)", "type": "string", "description": "Optional Authorization token (Bearer JWT) used to successfully reveal phone numbers. Leave blank if not available." }, "maxItems": { "title": "Maximum Items", "minimum": 1, "type": "integer", "description": "Maximum number of listing records to extract.", "default": 10 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "REQUIRED. Pre-configured residential proxies are recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }