{ "openapi": "3.0.1", "info": { "title": "OLX Real Estate Scraper", "description": "Search and scrape real estate listings from OLX across multiple country domains. Filter by property type, keyword, location, and price range. Extracts title, price, bedrooms, bathrooms, area, location, and listing URL — ideal for real estate market research in OLX-dominant markets.", "version": "1.0", "x-build-id": "zPwcgxQw4jrSDNclG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~olx-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-olx-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/w3crawler~olx-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-olx-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/w3crawler~olx-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-olx-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", "required": [ "domain" ], "properties": { "domain": { "title": "OLX country domain", "type": "string", "description": "Supported public OLX country domain, for example olx.pl, olx.pt, olx.ro, or olx.in.", "default": "olx.pl" }, "propertyType": { "title": "Property type", "enum": [ "for-sale", "for-rent", "land", "commercial", "all" ], "type": "string", "description": "Search term/filter for the requested real-estate market segment.", "default": "for-sale" }, "query": { "title": "Search keyword", "type": "string", "description": "Optional public search keyword, such as apartment or villa." }, "location": { "title": "Location", "type": "string", "description": "Optional city or region search term." }, "priceMin": { "title": "Minimum price", "type": "integer", "description": "Optional minimum price in the selected country's currency.", "default": 0 }, "priceMax": { "title": "Maximum price", "type": "integer", "description": "Optional maximum price in the selected country's currency.", "default": 0 }, "maxListings": { "title": "Maximum listings", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of unique real-estate listings to emit.", "default": 50 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Bounded number of page variants requested per source URL.", "default": 1 }, "startUrls": { "title": "Starting URLs", "type": "array", "description": "Optional HTTPS OLX URLs on the selected domain. When omitted, a public search URL is built from the filters.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "HTTPS URL on the selected OLX country domain." } }, "required": [ "url" ], "additionalProperties": false } }, "timeoutMs": { "title": "Request timeout (ms)", "type": "integer", "description": "Per-request timeout from 5000 to 120000 milliseconds.", "default": 30000 }, "maxBytes": { "title": "Maximum response bytes", "type": "integer", "description": "Maximum HTML/JSON response size from 1000 to 15000000 bytes.", "default": 5000000 }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Bounded delay before retrying a failed public request.", "default": 250 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Bounded retries for transient or access-boundary responses.", "default": 1 }, "fixturePath": { "title": "Local QA fixture path", "maxLength": 260, "type": "string", "description": "Optional checked-in HTML/JSON/TXT fixture path for deterministic local QA; never used as a live fallback." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional standard Apify Proxy settings. Direct requests are the default; enabled runs reuse one consistent session and do not bypass access controls.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }