{ "openapi": "3.0.1", "info": { "title": "OLX Brasil Scraper", "description": "Scrape cars, real estate, phones, and other ads from olx.com.br. Use the same listing filters as the site or paste an OLX URL — the URL wins when set.", "version": "0.3", "x-build-id": "IyxUx1SgmEGoGe18J" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dadhalfdev~olx-brasil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dadhalfdev-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/dadhalfdev~olx-brasil-scraper/runs": { "post": { "operationId": "runs-sync-dadhalfdev-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/dadhalfdev~olx-brasil-scraper/run-sync": { "post": { "operationId": "run-sync-dadhalfdev-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": { "input_url": { "title": "Input URL", "type": "string", "description": "Paste any OLX listing URL (cars, motos, apartments, phones, …). Overrides filters when set." }, "category": { "title": "Category", "enum": [ "brasil", "carros", "motos", "caminhoes", "onibus", "barcos", "pecas-carros", "imoveis-venda-apartamentos", "imoveis-venda-casas", "imoveis-aluguel-apartamentos", "imoveis-aluguel-casas", "imoveis-terrenos", "imoveis-temporada", "imoveis-comercial", "celulares", "notebooks", "consoles", "jogos", "tvs", "fones", "fogoes", "ciclismo", "academia", "brinquedos", "caes", "roupas", "instrumentos", "tratores", "equipamentos", "reforma", "vagas-administracao" ], "type": "string", "description": "Same listing category as olx.com.br. Ignored when input_url is set.", "default": "carros" }, "query": { "title": "Keyword", "type": "string", "description": "Same as the OLX search box (`?q=`). Ignored when input_url is set." }, "subcategory": { "title": "Subcategory / brand path", "type": "string", "description": "Optional extra path after the category, same as OLX (apple, honda, corolla). Ignored when input_url is set." }, "state": { "title": "State", "enum": [ "", "ac", "al", "am", "ap", "ba", "ce", "df", "es", "go", "ma", "mg", "ms", "mt", "pa", "pb", "pe", "pi", "pr", "rj", "rn", "ro", "rr", "rs", "sc", "se", "sp", "to" ], "type": "string", "description": "Same /estado-{uf}/ listing prefix as OLX Brasil. Ignored when input_url is set.", "default": "" }, "price_min": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Same Preço Min. (`ps=`). Ignored when input_url is set." }, "price_max": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Same Preço Máx. (`pe=`). Ignored when input_url is set." }, "advertiser": { "title": "Advertiser type", "enum": [ "", "particular", "profissional" ], "type": "string", "description": "Same Tipo de anunciante filter (`f=`). Ignored when input_url is set.", "default": "" }, "sort": { "title": "Sort", "enum": [ "", "relevance", "date", "price", "biggest_price" ], "type": "string", "description": "Same Ordenar por filter (`sf=`). Ignored when input_url is set.", "default": "relevance" }, "make": { "title": "Vehicle make", "enum": [ "", "gm-chevrolet", "vw-volkswagen", "fiat", "ford", "toyota", "honda", "hyundai", "renault", "mitsubishi", "nissan", "am-gen", "acura", "agrale", "alfa-romeo", "americar", "asia-motors", "aston-martin", "audi", "austin", "auto-gabarito", "bmw", "brm", "byd", "baby", "bentley", "bugatti", "buggy", "bugre", "cab-motors", "can-am", "cbt-jipe", "cadillac", "caoa-changan", "chana", "changan", "chery", "chrysler", "citroen", "cross-lander", "d2d", "dfsk", "dkw-vemag", "dacon", "daewoo", "daihatsu", "denza", "dodge", "effa", "engesa", "envemo", "ferrari", "fever", "fibravan", "foton", "fyber", "gac-motors", "gmc", "gwm", "geely", "great-wall", "gurgel", "hafei", "hitech-eletric", "infiniti", "isuzu", "iveco", "jac", "jpx", "jaecoo", "jaguar", "jeep", "jetour", "jinbei", "kia-motors", "lada", "lamborghini", "land-rover", "landwind", "leapmotor", "lexus", "lifan", "lobini", "lotus", "mg", "mp-lafer", "mahindra", "maserati", "matra", "mazda", "mclaren", "mercedes-benz", "mercury", "mini", "miura", "mon", "neta", "omoda", "peugeot", "plymouth", "pontiac", "porsche", "puma", "ram", "rely", "riddara", "rivian", "rolls-royce", "rover", "saab", "saturn", "seat", "seres", "shelby", "shineray", "smart", "ssangyong", "subaru", "sunbeam-talbot", "suzuki", "swell-mini-veiculos", "tac", "tesla", "troller", "vw", "ventura", "volvo", "wake", "walk", "willys-overland", "zeekr" ], "type": "string", "description": "Cars path slug (`toyota`, `gm-chevrolet`). For motos, used as /motos/{make}. Ignored when input_url is set.", "default": "" }, "model": { "title": "Vehicle model", "type": "string", "description": "Cars path after make, or motos `vm=`. Ignored when input_url is set." }, "version": { "title": "Vehicle version", "type": "string", "description": "Same Versão filter (`vv=`). Cars and motos. Ignored when input_url is set." }, "year_min": { "title": "Year from", "minimum": 1950, "maximum": 2035, "type": "integer", "description": "Same Ano (`rs=`). Cars and motos. Ignored when input_url is set." }, "year_max": { "title": "Year to", "minimum": 1950, "maximum": 2035, "type": "integer", "description": "Same Ano (`re=`). Cars and motos. Ignored when input_url is set." }, "mileage_min": { "title": "Mileage from (km)", "minimum": 0, "type": "integer", "description": "Same Quilometragem (`ms=`). Cars and motos. Ignored when input_url is set." }, "mileage_max": { "title": "Mileage to (km)", "minimum": 0, "type": "integer", "description": "Same Quilometragem (`me=`). Cars and motos. Ignored when input_url is set." }, "transmission": { "title": "Transmission", "enum": [ "", "manual", "automatico", "semi-automatico", "automatizado" ], "type": "string", "description": "Same Câmbio filter (`gb=`). Cars only. Ignored when input_url is set.", "default": "" }, "fuel": { "title": "Fuel", "enum": [ "", "gasolina", "alcool", "flex", "diesel", "hibrido", "eletrico" ], "type": "string", "description": "Same Combustível filter (`fu=`). Cars only. Ignored when input_url is set.", "default": "" }, "body_type": { "title": "Body type", "enum": [ "", "hatch", "seda", "suv", "pick-up", "van-utilitario", "perua", "coupe", "conversivel", "caminhao-leve", "buggy" ], "type": "string", "description": "Same Tipo filter (`ctp=`). Cars only. Ignored when input_url is set.", "default": "" }, "color": { "title": "Color", "enum": [ "", "preto", "branco", "prata", "vermelho", "cinza", "azul", "amarelo", "verde", "laranja", "outra" ], "type": "string", "description": "Same Cor filter (`cac=`). Cars and motos. Ignored when input_url is set.", "default": "" }, "doors": { "title": "Doors", "enum": [ "", "2", "4", "3" ], "type": "string", "description": "Same Portas filter (`cad=`). Cars only. Ignored when input_url is set.", "default": "" }, "steering": { "title": "Steering", "enum": [ "", "hidraulica", "eletrica", "mecanica", "eletro-hidraulica" ], "type": "string", "description": "Same Direção filter (`ics=`). Cars only. Ignored when input_url is set.", "default": "" }, "engine": { "title": "Engine", "enum": [ "", "1.0", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "1.9", "2.0-2.9", "3.0-3.9", "4.0-plus" ], "type": "string", "description": "Same Motor filter (`motp=`). Cars only. Ignored when input_url is set.", "default": "" }, "accepts_trade": { "title": "Accepts trade", "enum": [ "", "sim", "nao" ], "type": "string", "description": "Same Aceita Trocas filter (`exc=`). Ignored when input_url is set.", "default": "" }, "feature": { "title": "Optional feature", "enum": [ "", "ar-condicionado", "vidro-eletrico", "trava-eletrica", "air-bag", "alarme", "som", "sensor-de-re", "camera-de-re", "blindado", "bancos-de-couro", "computador-de-bordo", "usb", "volante-multifuncional", "bluetooth", "gps", "piloto-automatico", "rodas-liga-leve", "teto-solar", "tracao-4x4" ], "type": "string", "description": "Same Opcionais filter (`cf=`). Cars only. Ignored when input_url is set.", "default": "" }, "gnv_kit": { "title": "GNV kit", "enum": [ "", "sim", "nao" ], "type": "string", "description": "Same Kit GNV filter (`hgnv=`). Cars only. Ignored when input_url is set.", "default": "" }, "financial_status": { "title": "Financial status", "enum": [ "", "quitado", "financiado" ], "type": "string", "description": "Same Estado financeiro filter (`fncs=`). Cars and motos. Ignored when input_url is set.", "default": "" }, "documentation": { "title": "Documentation", "enum": [ "", "ipva-pago", "com-multas", "de-leilao" ], "type": "string", "description": "Same Documentação e regularização filter (`doc=`). Cars and motos. Ignored when input_url is set.", "default": "" }, "conservation": { "title": "Conservation", "enum": [ "", "unico-dono", "com-manual", "chave-reserva", "revisoes-concessionaria", "com-garantia" ], "type": "string", "description": "Same Conservação e garantia filter (`cnwa=`). Cars only. Ignored when input_url is set.", "default": "" }, "plate_end": { "title": "License plate ending", "enum": [ "", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9" ], "type": "string", "description": "Same Final de placa filter (`et=`). Cars only. Ignored when input_url is set.", "default": "" }, "moto_type": { "title": "Motorcycle type", "enum": [ "", "street", "esportiva", "custom", "trail", "naked", "scooter", "offroad", "touring" ], "type": "string", "description": "Same Tipo de moto filter (`mt=`). Motos only. Ignored when input_url is set.", "default": "" }, "festival": { "title": "Festival de Carros", "type": "boolean", "description": "Same Festival de Carros toggle (`vt=1`). Cars only. Ignored when input_url is set.", "default": false }, "vehicle_history": { "title": "Vehicle history", "type": "boolean", "description": "Same Histórico Veicular toggle (`vtvh=`). Cars only. Ignored when input_url is set.", "default": false }, "inspected": { "title": "Inspected", "type": "boolean", "description": "Same Vistoriado toggle (`crss=`). Cars and motos. Ignored when input_url is set.", "default": false }, "below_fipe": { "title": "Below FIPE", "type": "boolean", "description": "Same Ofertas abaixo da FIPE toggle (`fpdll=`). Cars and motos. Ignored when input_url is set.", "default": false }, "rooms": { "title": "Bedrooms", "enum": [ "", "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Same Número de quartos (`ros=`). Real estate only. Ignored when input_url is set.", "default": "" }, "bathrooms": { "title": "Bathrooms", "enum": [ "", "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Same Número de banheiros (`bas=`). Real estate only. Ignored when input_url is set.", "default": "" }, "garage_spaces": { "title": "Garage spaces", "enum": [ "", "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Same Vagas na garagem (`gsp=`). Real estate only. Ignored when input_url is set.", "default": "" }, "property_subtype": { "title": "Property subtype", "enum": [ "", "casa-de-condominio", "casa-de-vila", "cobertura", "duplex-triplex", "kitnet", "loft", "padrao" ], "type": "string", "description": "Same Subtipo do imóvel (`rts=`). Real estate only. Ignored when input_url is set.", "default": "" }, "area_min": { "title": "Area from (m²)", "minimum": 0, "type": "integer", "description": "Same Área (`ss=`). Real estate only. Ignored when input_url is set." }, "area_max": { "title": "Area to (m²)", "minimum": 0, "type": "integer", "description": "Same Área (`se=`). Real estate only. Ignored when input_url is set." }, "iptu_min": { "title": "IPTU from (BRL)", "minimum": 0, "type": "integer", "description": "Same IPTU (`ips=`). Real estate only. Ignored when input_url is set." }, "iptu_max": { "title": "IPTU to (BRL)", "minimum": 0, "type": "integer", "description": "Same IPTU (`ipe=`). Real estate only. Ignored when input_url is set." }, "moving_festival": { "title": "Festival da Mudança", "type": "boolean", "description": "Same Festival da Mudança toggle (`fma=1`). Real estate only. Ignored when input_url is set.", "default": false }, "phone_brand": { "title": "Phone brand", "enum": [ "", "apple", "samsung", "xiaomi", "motorola", "lg", "lenovo", "asus", "huawei", "infinix" ], "type": "string", "description": "Same /celulares/{brand} path (apple, samsung, …). Phones only. Ignored when input_url is set.", "default": "" }, "phone_condition": { "title": "Phone condition", "enum": [ "", "novo", "usado-excelente", "usado-bom", "recondicionado", "com-defeito" ], "type": "string", "description": "Same Condição filter (`elcd=`). Phones only. Ignored when input_url is set.", "default": "" }, "donate": { "title": "For donation", "type": "boolean", "description": "Same Para Doação toggle (`de=1`). Phones only. Ignored when input_url is set.", "default": false }, "max_results": { "title": "Maximum number of results", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many rows to return (1–2000). OLX lists 50 ads per page and stops around page 100.", "default": 50 } } }, "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 } } } } } } } } } }