{ "openapi": "3.0.1", "info": { "title": "OLX Brazil Scraper — Any Category, Any Keyword", "description": "Searches any category on olx.com.br - real estate, cars, electronics, anything - and returns priced listings with structured attributes (area, bedrooms, mileage, color, engine) parsed from the site's own detail chips. No seller identity is ever collected.", "version": "0.1", "x-build-id": "NDf4l1G8cXy2YfiqY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reventadata~olx-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reventadata-olx-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/reventadata~olx-scraper/runs": { "post": { "operationId": "runs-sync-reventadata-olx-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/reventadata~olx-scraper/run-sync": { "post": { "operationId": "run-sync-reventadata-olx-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": { "categoryPath": { "title": "Category path", "type": "string", "description": "The URL path segment(s) OLX BR itself uses for a category, transaction type, location and (for autos) registration year - copy them straight from the site's address bar. Examples: \"imoveis\" (all real estate nationwide), \"imoveis/aluguel/apartamentos/estado-df/distrito-federal-e-regiao/brasilia\" (apartments for rent in Brasília), \"autos-e-pecas/carros-vans-e-utilitarios\" (all cars/vans), \"autos-e-pecas/carros-vans-e-utilitarios/2019\" (cars registered 2019). Leave empty to search all of olx.com.br nationwide.", "default": "" }, "searchQueries": { "title": "Search terms", "type": "array", "description": "Optional keywords. Each one narrows WITHIN the category path above - it does not replace it (confirmed: \"autos-e-pecas/carros-vans-e-utilitarios\" + q=civic returns only Civics, still inside the cars category). Leave empty to browse the category path unfiltered, which is a fully valid run on its own.", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "newest", "priceAsc", "priceDesc" ], "type": "string", "description": "Order only; changes nothing about which listings exist.", "default": "relevance" }, "minPrice": { "title": "Minimum price (R$)", "minimum": 0, "type": "integer", "description": "Optional. Omitted from the request entirely when empty - never defaulted to 0, which would drop every free listing." }, "maxPrice": { "title": "Maximum price (R$)", "minimum": 0, "type": "integer", "description": "Optional. Omitted from the request entirely when empty." }, "minMileageKm": { "title": "Minimum mileage (km)", "minimum": 0, "type": "integer", "description": "Autos category only. Verified genuinely bounded on the autos vertical; not confirmed whether other categories honour it at all (likely ignored there)." }, "maxMileageKm": { "title": "Maximum mileage (km)", "minimum": 0, "type": "integer", "description": "Autos category only. Same caveat as the minimum." }, "acceptsTradeOnly": { "title": "Accepts trade-ins only", "type": "boolean", "description": "Autos category only (\"Aceita trocas\" badge). Verified genuinely filtered, not a silently-ignored parameter, on the autos vertical.", "default": false }, "requireKeywordMatch": { "title": "Require every search word in the title", "type": "boolean", "description": "A defensive second pass after OLX's own `q` narrowing - drops a row whose title is missing a word of the search term. Has no effect when searchQueries is empty.", "default": true }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Hard cap on rows pushed across all search terms (or the single category browse, if searchQueries is empty). Default lowered to 300 (from 1000) on 2026-08-22 - a 1000-row nationwide browse measured 244s against Apify's 5-minute daily auto-test window, too little headroom; 300 rows measured well inside it.", "default": 300 }, "maxPages": { "title": "Maximum pages per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "olx.com.br clamps every search at page 100 (confirmed: pages 101 through at least 1000 serve byte-identical content to page 100), about 5,000 listings. This is clamped to that ceiling regardless of what is entered.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "olx.com.br blocks plain HTTP, Apify datacenter and Apify residential proxies outright (identical ~5.8 KB block page in every case, measured 25/25). Only Apify Unblocker and Bright Data reach the site; Unblocker is the default and needs no vendor account.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } } } }, "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 } } } } } } } } } }