{ "openapi": "3.0.1", "info": { "title": "OLX Brazil Scraper", "description": "Scrape OLX Brazil (olx.com.br) listings from any search URL: price, location, rooms, area, condo fee, mileage, photos, listing date, seller type. Real estate, cars and all categories.", "version": "0.1", "x-build-id": "KWn1Ed4XdjbK1ItxF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~olx-brazil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-olx-brazil-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/tortuga~olx-brazil-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-olx-brazil-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/tortuga~olx-brazil-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-olx-brazil-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "OLX Brazil search or category pages, with any filters and sort applied in the browser, e.g. https://www.olx.com.br/imoveis/venda/estado-sp, https://www.olx.com.br/autos-e-pecas/carros-vans-e-utilitarios/estado-rj?ps=30000&pe=80000, https://www.olx.com.br/brasil?q=iphone+15. Use www.olx.com.br URLs (regional sub-domains like sp.olx.com.br only work for single ad pages). A single ad URL (…/-) is also accepted and returns that one listing with full details. Leave empty if you use Category / State / Search query instead.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "category": { "title": "Category", "type": "string", "description": "Alternative to Start URLs: an OLX category path, e.g. imoveis, imoveis/venda, imoveis/aluguel, imoveis/terrenos, autos-e-pecas/carros-vans-e-utilitarios, autos-e-pecas/motos, eletronicos-e-celulares, celulares, para-a-sua-casa, esportes-e-lazer, moda-e-beleza. Leave empty to search all categories." }, "state": { "title": "State (UF)", "type": "string", "description": "Used with Category / Search query: two-letter Brazilian state, e.g. sp, rj, mg, rs, pr, ba. Leave empty for the whole country." }, "searchQuery": { "title": "Search query", "type": "string", "description": "Keyword search within the category and state, e.g. \"apartamento 2 quartos\", \"honda civic\", \"iphone 15\"." }, "minPrice": { "title": "Min price (BRL)", "minimum": 0, "type": "integer", "description": "Used with Category / State / Search query. Sale price, or monthly rent for rentals." }, "maxPrice": { "title": "Max price (BRL)", "minimum": 0, "type": "integer", "description": "Used with Category / State / Search query. Sale price, or monthly rent for rentals." }, "sort": { "title": "Sort", "enum": [ "", "newest", "price_asc" ], "type": "string", "description": "Used with Category / State / Search query. OLX's default is relevance.", "default": "" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many listings in total (across all start URLs). Keeps cost predictable. OLX shows 50 ads per page and serves at most 100 pages (5,000 ads) per search, so split large searches by state, city, category or price band to get more.", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Also open every ad page to get the full description, the complete attribute list, CEP (postal code), street (when the seller shows it), map coordinates (real estate), condo fee and IPTU details, financing / installment info, FIPE and market price reference (vehicles), highlights, videos and the seller's business name. One extra request per listing; charged extra per listing (see pricing).", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is recommended. OLX sits behind Cloudflare; datacenter IPs worked in testing, but if you see 403/429 in the run log switch to the RESIDENTIAL group.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }