{ "openapi": "3.0.1", "info": { "title": "OLX Brasil Scraper — Ads, Prices & Listings", "description": "🔥 Up to 30% OFF! Scrape OLX Brasil classifieds — no login. By search, category or ad URL: title, price, full specs & attributes, all images, seller, location (city, CEP, DDD, GPS) and total results. Fast HTTP, cheap. Perfect for market research & lead gen. ⚡", "version": "0.0", "x-build-id": "7vPYpwc8xnBL3o4Pe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bgfc97~olx-brasil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bgfc97-olx-brasil-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/bgfc97~olx-brasil-scraper/runs": { "post": { "operationId": "runs-sync-bgfc97-olx-brasil-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/bgfc97~olx-brasil-scraper/run-sync": { "post": { "operationId": "run-sync-bgfc97-olx-brasil-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": { "search": { "title": "Search keywords", "type": "array", "description": "Keywords to search on OLX Brasil, one per line, e.g. \"iphone 13\". Each keyword becomes its own search (combined with Category / State / Sort if set). Provide at least one of \"search\" or \"urls\".", "items": { "type": "string" } }, "category": { "title": "Category (optional)", "type": "string", "description": "OLX category path/slug to restrict the search to, e.g. \"celulares\", \"autos-e-pecas/carros-vans-e-utilitarios\", or a deeper facet like \"celulares/apple/iphone-13\" (copy the path segment(s) after olx.com.br/ from a real category page). Combined with any keyword in \"search\"; ignored if empty." }, "state": { "title": "State / region (optional)", "type": "string", "description": "Restrict results to a Brazilian state. A 2-letter state code (UF), e.g. \"sp\", \"rj\", \"mg\", is applied as OLX's own official \"estado-\" filter path. Anything else (a city/region name) isn't a guaranteed OLX path, so it is honestly appended as extra search text instead of a hard filter — check the \"state\"/\"city\" fields on each result to confirm. (Alias: \"location\".)" }, "sort": { "title": "Sort order", "enum": [ "relevance", "date", "price", "biggest_price" ], "type": "string", "description": "How to order the search results (OLX's own sort).", "default": "relevance" }, "urls": { "title": "OLX URLs (optional)", "type": "array", "description": "Direct olx.com.br URLs to open: either search-result URLs (e.g. https://www.olx.com.br/brasil?q=iphone+13 or https://www.olx.com.br/estado-sp?q=iphone+13) which get paginated like a keyword search, or individual ad/listing URLs (e.g. https://sp.olx.com.br/.../iphone-13-1234567890) which get opened and scraped in full detail. Provide at least one of \"search\" or \"urls\".", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of ads to return in total across all searches/URLs. The scraper paginates automatically until it reaches this cap or runs out of results.", "default": 40 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages/ads to fetch in parallel. Higher is faster but uses more residential bandwidth at once.", "default": 4 }, "maxRetries": { "title": "Max retries per request", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many times to retry a request (each retry rotates to a fresh residential IP) before giving up on that page.", "default": 4 }, "includeRaw": { "title": "Include raw source object", "type": "boolean", "description": "Also attach OLX's full raw ad object under \"raw\" on each item (larger output; useful if you need a field this Actor doesn't surface yet).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. RESIDENTIAL is required and defaults to Brazil IPs — OLX Brasil sits behind Cloudflare and hard-blocks datacenter IPs outright (verified), even with a perfect browser TLS fingerprint.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }, "timeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 20, "maximum": 180, "type": "integer", "description": "How long to wait for a single page to load before retrying it.", "default": 60 } } }, "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 } } } } } } } } } }