{ "openapi": "3.0.1", "info": { "title": "OLX Brazil Scraper - Past the 5,000-Listing Search Wall", "description": "[$1.50 / 1K, no start fee] OLX Brasil listings past the 5,000-per-search wall: the Actor slices a big search into price bands on its own. Price drops, CEP, neighbourhood and category attributes per listing; descriptions and seller sales history are an opt-in extra.", "version": "0.1", "x-build-id": "3ilGDxScUeHsynafN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdata_labs~olx-brazil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdata_labs-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/webdata_labs~olx-brazil-scraper/runs": { "post": { "operationId": "runs-sync-webdata_labs-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/webdata_labs~olx-brazil-scraper/run-sync": { "post": { "operationId": "run-sync-webdata_labs-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": { "searchQueries": { "title": "Search terms", "type": "array", "description": "What to search OLX Brasil for, in Portuguese or English. Each term becomes its own search and the results are merged and de-duplicated by listing ID. Example: \"iphone 13\", \"honda civic\".", "items": { "type": "string" } }, "searchUrls": { "title": "OLX search URLs", "type": "array", "description": "Paste any olx.com.br listing URL with your filters already applied and the Actor takes it from there, including category and state paths such as https://www.olx.com.br/imoveis/venda/estado-sp. Filters set in this form fill the gaps the URL leaves; anything the URL already says wins. Regional sp.olx.com.br style links are rewritten so they keep working.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "imoveis", "imoveis/venda", "imoveis/aluguel", "imoveis/temporada", "imoveis/terrenos", "imoveis/comercio-e-industria", "imoveis/lancamentos", "autos-e-pecas", "autos-e-pecas/carros-vans-e-utilitarios", "autos-e-pecas/motos", "autos-e-pecas/onibus", "autos-e-pecas/caminhoes", "autos-e-pecas/barcos-e-aeronaves", "autos-e-pecas/pecas-e-acessorios", "autos-e-pecas/pecas-e-acessorios/carros-vans-e-utilitarios", "autos-e-pecas/pecas-e-acessorios/motos", "autos-e-pecas/pecas-e-acessorios/onibus", "autos-e-pecas/pecas-e-acessorios/caminhoes", "autos-e-pecas/pecas-e-acessorios/barcos-e-aeronaves", "para-a-sua-casa", "para-a-sua-casa/cama-mesa-e-banho", "para-a-sua-casa/decoracoes-para-casa", "para-a-sua-casa/casa-inteligente", "para-a-sua-casa/utensilios-para-cozinha", "para-a-sua-casa/utensilios-para-banheiro-e-limpeza", "para-a-sua-casa/iluminacao", "para-a-sua-casa/seguranca-residencial", "para-a-sua-casa/jardinagem-e-plantas", "para-a-sua-casa/area-externa", "moveis", "moveis/camas-e-colchoes", "moveis/sofas-e-poltronas", "moveis/cadeiras-de-escritorio-e-gamer", "moveis/bancos-e-cadeiras", "moveis/mesas", "moveis/escrivaninhas-e-penteadeiras", "moveis/racks-e-paineis", "moveis/armarios-e-guarda-roupas", "moveis/moveis-para-organizacao", "eletro", "eletro/ar-condicionados", "eletro/ventiladores-e-climatizadores", "eletro/geladeiras-e-freezers", "eletro/fogoes-e-fornos", "eletro/maquinas-de-lavar-e-secadoras", "eletro/eletroportateis-para-cozinha-e-limpeza", "eletro/eletroportateis-para-cuidados-pessoais", "materiais-de-construcao", "materiais-de-construcao/fundacao-e-estrutura", "materiais-de-construcao/alvenaria", "materiais-de-construcao/pisos-e-revestimentos", "materiais-de-construcao/portas-e-janelas", "materiais-de-construcao/cubas-e-pias", "materiais-de-construcao/torneiras-duchas-e-vasos", "materiais-de-construcao/instalacoes-eletricas-e-hidraulicas", "materiais-de-construcao/ferramentas-de-construcao", "materiais-de-construcao/ferramentas-de-pintura", "eletronicos-e-celulares", "celulares", "eletronicos-e-celulares/acessorios-de-celular", "eletronicos-e-celulares/pecas-de-celular", "eletronicos-e-celulares/smartwatches", "eletronicos-e-celulares/acessorios-para-smartwatch", "eletronicos-e-celulares/telefonia-fixa-e-sem-fio", "informatica", "informatica/computadores-e-desktops", "informatica/notebooks", "informatica/monitores", "informatica/perifericos-e-acessorios-de-computador", "informatica/pecas-de-hardware", "informatica/armazenamento", "informatica/memoria-ram", "informatica/processadores", "informatica/placas-de-video", "informatica/conectividade-e-dispositivos-de-rede", "informatica/tablets-e-readers", "games", "games/consoles-de-video-game", "games/jogos-de-video-game", "games/acessorios-de-video-game", "tvs-e-video", "tvs-e-video/tvs", "tvs-e-video/acessorios-para-tv", "tvs-e-video/projetores-e-telas-de-projecao", "tvs-e-video/dvd-blu-ray-video-cassete", "tvs-e-video/dispositivos-de-streaming", "audio", "audio/fones-de-ouvido", "audio/aparelhos-de-som", "audio/microfones-e-gravadores", "audio/equipamentos-e-acessorios-de-som", "cameras-e-drones", "cameras-e-filmadoras", "acessorios-para-cameras-e-filmadoras", "drones", "moda-e-beleza", "beleza-e-saude", "roupas", "bolsas-malas-e-mochilas", "bijouteria-relogios-e-acessorios", "calcados", "comercio-e-escritorio", "comercio-e-escritorio/equipamentos", "comercio-e-escritorio/gastronomia", "comercio-e-escritorio/equipamento-medico", "comercio-e-escritorio/uniformes-epis", "comercio-e-escritorio/trailers-e-carrinhos-comerciais", "escritorio", "escritorio/itens-para-escritorio", "escritorio/cadeiras-de-escritorio", "escritorio/moveis-de-escritorio", "escritorio/papelaria", "musica-e-hobbies", "instrumentos-musicais", "cds-dvds", "livros-e-revistas", "antiguidades", "hobbies-e-colecoes", "esportes-e-lazer", "ciclismo", "esportes-e-lazer/academia-e-exercicios", "esportes-e-lazer/acampamento", "esportes-e-lazer/esportes-sobre-rodas", "esportes-e-lazer/quadra-e-ao-ar-livre", "esportes-e-lazer/esportes-aquaticos", "esportes-e-lazer/roupas-esportivas", "esportes-e-lazer/calcados-esportivos", "esportes-e-lazer/acessorios-de-ciclismo", "artigos-infantis", "artigos-infantis/roupas-infantis", "artigos-infantis/calcados-infantis", "artigos-infantis/roupas-para-bebes", "artigos-infantis/calcados-para-bebes", "artigos-infantis/brinquedos", "artigos-infantis/maternidade-e-bebes", "artigos-infantis/moveis-infantis", "animais-de-estimacao", "animais-de-estimacao/cachorros", "animais-de-estimacao/gatos", "animais-de-estimacao/acessorios", "animais-de-estimacao/roedores", "animais-de-estimacao/outros-animais", "agro-e-industria", "agro-e-industria/tratores-e-maquinas-agricolas", "agro-e-industria/maquinas-pesadas-para-construcao", "agro-e-industria/maquinas-para-producao-industrial", "agro-e-industria/pecas-para-tratores-e-maquinas", "agro-e-industria/animais-para-agropecuaria", "agro-e-industria/producao-rural", "agro-e-industria/outros-itens-para-agro-e-industria", "servicos", "vagas-de-emprego", "festas-e-casamentos", "festas-e-casamentos/convites-e-papelaria", "festas-e-casamentos/decoracao-e-cenografia", "festas-e-casamentos/baloes-e-inflaveis", "festas-e-casamentos/topos-de-bolo-e-velas", "festas-e-casamentos/lembrancinhas-e-brindes", "festas-e-casamentos/acessorios-para-noivas-e-noivos", "festas-e-casamentos/outros-itens-de-festa" ], "type": "string", "description": "Restrict the search to one OLX category. Also required for the condition and top-rated-seller filters below, which OLX only applies inside a category. Leave empty to search all of OLX." }, "state": { "title": "State", "enum": [ "AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO" ], "type": "string", "description": "Two-letter Brazilian state code (UF). Leave empty to search the whole country. The state is applied at the source, so it never costs you scanned rows." }, "listingUrls": { "title": "Specific listing URLs", "type": "array", "description": "Scrape named listings instead of searching. Full OLX ad URLs, or bare listing IDs. Search filters are not applied to these.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Lowest asking price in Brazilian Reais, inclusive. Applied by OLX itself. Listings with no published price are excluded once you set a price bound." }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Highest asking price in Brazilian Reais, inclusive. Applied by OLX itself." }, "condition": { "title": "Condition", "type": "array", "description": "Keep only listings in these conditions. OLX only applies this inside a category, so set \"Category\" or use a category URL. Empty means any condition.", "items": { "type": "string", "enum": [ "New", "Used - excellent", "Used - good", "Refurbished", "For parts or damaged" ] } }, "sellerType": { "title": "Seller type", "enum": [ "any", "private", "business" ], "type": "string", "description": "Private sellers only, business sellers only (lojas e profissionais), or both. Private-only is applied by OLX; business-only is applied here, because OLX's own filter cannot express it.", "default": "any" }, "onlyGoodSellers": { "title": "Only top-rated sellers", "type": "boolean", "description": "Keep only sellers OLX rates above four stars. Applied at the source, and like \"Condition\" it needs a category to take effect. Narrows results hard: about one listing in nine survives it.", "default": false }, "publishedWithinDays": { "title": "Published within (days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "Keep only listings published in the last N days. 0 means any age. Measured from OLX's own publication timestamp, not the bump that moves an old ad back to the top.", "default": 0 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Which listings OLX serves first. Relevance, newest and lowest price are applied by OLX. OLX has no highest-price order in its URLs, so that one is applied to the listings collected instead, and only on runs capped at 10,000 or fewer.", "default": "relevance" }, "splitLargeSearches": { "title": "Go past OLX's 5,000-listing limit", "type": "boolean", "description": "On by default. OLX serves at most 5,000 listings for any one search, however hard you page. When a search has more matches than that and you asked for more than 5,000 results, the Actor cuts it into narrower price bands, and then into states, until every slice fits under the limit. Turn off to stay inside a single search.", "default": true }, "enrichDetails": { "title": "Include description and seller details", "type": "boolean", "description": "Off by default. Opens each listing to add the full description, the CEP postal code, the seller's name and account ID, whether the account is a verified business, its completed and cancelled sale counts and average dispatch time, and whether a phone number is on file. A listing page costs about 190 times the bandwidth of a search result, so it is charged separately as \"listing-enriched\" and only for listings you actually receive.", "default": false }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Listings returned by the run. The default keeps a first run cheap and quick; set 0 for unlimited, there is no hard ceiling. Anything above 5,000 needs \"Go past OLX's 5,000-listing limit\" left on.", "default": 100 } } }, "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 } } } } } } } } } }