{ "openapi": "3.0.1", "info": { "title": "OLX Global Scraper", "description": "Scrape OLX classified-ad listings across 24 countries (Poland, Ukraine, Brazil, India, Pakistan, Indonesia, Argentina, Türkiye, Portugal, ...). Search by keyword, browse by category / city, fetch listing details, list seller ads, or accept any OLX URL.", "version": "1.0", "x-build-id": "4fqxPynbZWosPN5Ne" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~olx-global-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-olx-global-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/crawlerbros~olx-global-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-olx-global-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/crawlerbros~olx-global-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-olx-global-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", "mode" ], "properties": { "country": { "title": "Country", "enum": [ "pl", "ua", "ro", "bg", "kz", "uz", "br", "ar", "co", "cl", "pe", "do", "in", "pk", "id", "tr", "za", "ma", "dz", "tn", "lb", "jo", "qa", "pt" ], "type": "string", "description": "Which OLX country site to scrape. Selects the appropriate domain (olx.pl, olx.ua, ...) and currency.", "default": "pl" }, "mode": { "title": "Mode", "enum": [ "searchListings", "byCategory", "byCity", "byListing", "bySeller", "byUrl" ], "type": "string", "description": "Which lookup axis to use.", "default": "searchListings" }, "query": { "title": "Search query (mode=searchListings, byCity)", "type": "string", "description": "Free-text search query.", "default": "laptop" }, "category": { "title": "Category (mode=byCategory)", "enum": [ "", "motoryzacja", "nieruchomosci", "praca", "elektronika", "moda", "dom-i-ogrod", "dla-dzieci", "sport-hobby", "muzyka-edukacja", "zwierzeta", "uslugi", "rolnictwo", "oddam-za-darmo" ], "type": "string", "description": "Top-level category. OLX uses different country-specific slugs, so the actor maps these onto each domain. (any) = no category filter.", "default": "" }, "city": { "title": "City slug (mode=byCity)", "type": "string", "description": "City slug as it appears in OLX URLs (e.g. 'warszawa', 'krakow', 'sao-paulo', 'mumbai'). Country-specific.", "default": "" }, "listingUrls": { "title": "Listing URLs (mode=byListing)", "type": "array", "description": "Direct OLX listing detail URLs. Country prefix is auto-detected from each URL.", "default": [], "items": { "type": "string" } }, "sellerUrl": { "title": "Seller profile URL (mode=bySeller)", "type": "string", "description": "OLX seller / user profile URL (e.g. https://www.olx.pl/oferty/uzytkownik/abc123/).", "default": "" }, "urls": { "title": "Mixed OLX URLs (mode=byUrl)", "type": "array", "description": "Any mix of OLX URLs across countries — listing pages, search pages, category pages, city pages, seller pages.", "default": [], "items": { "type": "string" } }, "condition": { "title": "Condition filter", "enum": [ "", "new", "used" ], "type": "string", "description": "Filter to new or used listings.", "default": "" }, "priceMin": { "title": "Min price", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop listings below this price (in the country's local currency)." }, "priceMax": { "title": "Max price", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop listings above this price." }, "fetchListingDetails": { "title": "Fetch listing details", "type": "boolean", "description": "For search / category / city modes, additionally fetch each listing's detail page for richer data (full description, all images, location, seller). Adds 1 HTTP request per listing.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 25 }, "maxPages": { "title": "Max listing pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum paginated listing pages (?page=N) to crawl per seed URL. Each page returns ~52 listings on most OLX sites.", "default": 3 }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route HTTP requests through Apify proxy. Some OLX countries (e.g. Brazil, India) block datacenter IPs — enable this if direct fetches return 403.", "default": false }, "autoEscalateOnBlock": { "title": "Auto-escalate on block", "type": "boolean", "description": "If a 403 / Cloudflare challenge appears on a country site, automatically retry through the Apify proxy.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Used when useProxy is enabled or auto-escalation triggers.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } } } } } } } } }