{ "openapi": "3.0.1", "info": { "title": "OpenSooq Scraper: MENA Classifieds & Cars", "description": "Scrape product listings, cars, and real estate from OpenSooq across Jordan, Saudi Arabia, UAE, and 17 MENA countries. Get clean lists of prices, specifications, locations, and images with zero browser overhead. $2.99 per 1,000 results.", "version": "0.1", "x-build-id": "tm4ySOhzX838t88bW" }, "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": "Text keyword to search for (e.g., 'iphone', 'apartment', 'bmw'). Leave empty if using Bulk Queries below.", "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" } } } }, "category": { "title": "Category", "enum": [ "", "1775", "5505", "2143", "13741", "2131", "7713", "8035", "2181", "54963", "54965", "7105", "88", "15981", "4275", "15061", "15101", "5141" ], "type": "string", "description": "Filter listings by major categories.", "default": "" }, "city": { "title": "City", "type": "string", "description": "City name (e.g., 'Amman', 'Riyadh') or numeric city ID. Leave empty for all.", "default": "" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Neighborhood name or numeric ID. Requires a City to be set first.", "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." }, "sortBy": { "title": "Sort Order", "enum": [ "recent", "default", "price-", "price+" ], "type": "string", "description": "Order results in the listings search results.", "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 } } } } } } } } } }