{ "openapi": "3.0.1", "info": { "title": "Brazil Car Scraper: Carros Usados e Novos, FIPE Gap and Alerts", "description": "Scrape Webmotors carros usados e novos and motos across Brazil with 40+ filters: make, model, year, price, km, fuel, state, city, seller. Each row has FIPE percent, specs, photos and dealer data. Monitor NEW, PRICE_DROP and REMOVED listings on a schedule. No login. Pay per listing.", "version": "0.1", "x-build-id": "bmi7czEk0hH0Z1rax" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~webmotors-vehicles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-webmotors-vehicles-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/getascraper~webmotors-vehicles-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-webmotors-vehicles-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/getascraper~webmotors-vehicles-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-webmotors-vehicles-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": "Webmotors search pages", "type": "array", "description": "Optional. Paste search pages copied from webmotors.com.br (for example a page you filtered by hand). Each page is read with its own filters. Leave empty to use the filters below.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "vehicleType": { "title": "Vehicle type", "enum": [ "cars", "motorcycles" ], "type": "string", "description": "Search cars or motorcycles.", "default": "cars" }, "condition": { "title": "Condition", "enum": [ "any", "used", "new" ], "type": "string", "description": "Used (seminovos), brand new (0 km) or both.", "default": "any" }, "makes": { "title": "Makes", "type": "array", "description": "Brands to include, for example Toyota, Honda, Volkswagen. Several makes are searched together. Names are not case sensitive.", "default": [], "items": { "type": "string" } }, "models": { "title": "Models", "type": "array", "description": "Models to include, for example Corolla, Yaris. With exactly one make the site filters by model; with several makes the models are matched on the listing title.", "default": [], "items": { "type": "string" } }, "version": { "title": "Version (exact)", "type": "string", "description": "Exact version text as Webmotors shows it, for example \"2.0 VVT-IE FLEX XEI DIRECT SHIFT\". Needs exactly one make and one model." }, "keywords": { "title": "Must mention (any)", "type": "array", "description": "Keep only listings whose title, description or highlights contain at least one of these words, for example \"único dono\" or \"revisões\".", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Must not mention", "type": "array", "description": "Drop listings whose title, description or highlights contain any of these words, for example \"sinistro\" or \"repasse\".", "default": [], "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Search one or more Brazilian states. Each state is searched separately and results are merged.", "items": { "type": "string", "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" ], "enumTitles": [ "Acre (AC)", "Alagoas (AL)", "Amapá (AP)", "Amazonas (AM)", "Bahia (BA)", "Ceará (CE)", "Distrito Federal (DF)", "Espírito Santo (ES)", "Goiás (GO)", "Maranhão (MA)", "Mato Grosso (MT)", "Mato Grosso do Sul (MS)", "Minas Gerais (MG)", "Pará (PA)", "Paraíba (PB)", "Paraná (PR)", "Pernambuco (PE)", "Piauí (PI)", "Rio de Janeiro (RJ)", "Rio Grande do Norte (RN)", "Rio Grande do Sul (RS)", "Rondônia (RO)", "Roraima (RR)", "Santa Catarina (SC)", "São Paulo (SP)", "Sergipe (SE)", "Tocantins (TO)" ] }, "default": [] }, "cities": { "title": "Cities", "type": "array", "description": "Cities written as city, then the two-letter state, for example \"Campinas, SP\" or \"Curitiba, PR\". When set, cities replace the state list.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Minimum price (R$)", "minimum": 0, "type": "number", "description": "Lowest asking price in Brazilian reais." }, "maxPrice": { "title": "Maximum price (R$)", "minimum": 0, "type": "number", "description": "Highest asking price in Brazilian reais." }, "minYear": { "title": "Earliest model year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Oldest model year to include, for example 2018." }, "maxYear": { "title": "Latest model year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Newest model year to include, for example 2024." }, "minMileage": { "title": "Minimum mileage (km)", "minimum": 0, "type": "integer", "description": "Lowest odometer reading." }, "maxMileage": { "title": "Maximum mileage (km)", "minimum": 0, "type": "integer", "description": "Highest odometer reading, for example 60000." }, "belowFipeOnly": { "title": "Only listings priced below FIPE", "type": "boolean", "description": "Keep only listings Webmotors flags as priced under the FIPE reference table (\"Super Preço\").", "default": false }, "maxFipePercent": { "title": "Maximum price as % of FIPE", "minimum": 1, "maximum": 300, "type": "integer", "description": "Keep listings whose price is at most this percent of the FIPE value Webmotors shows, for example 92 for at least 8 percent under FIPE. Listings without a FIPE figure are dropped." }, "transmissions": { "title": "Transmission", "type": "array", "description": "Gearbox types to include.", "items": { "type": "string", "enum": [ "Automática", "Manual", "CVT", "Semi-automática", "Automatizada", "Automatizada DCT" ], "enumTitles": [ "Automatic (Automática)", "Manual", "CVT", "Semi-automatic", "Automated", "Automated dual clutch (DCT)" ] }, "default": [] }, "fuels": { "title": "Fuel", "type": "array", "description": "Fuels to include. When exactly one fuel is chosen every row also carries it as \"fuelType\".", "items": { "type": "string", "enum": [ "Gasolina e álcool", "Gasolina", "Diesel", "Gasolina e elétrico", "Elétrico", "Álcool", "Gás natural", "Gasolina e gás natural" ], "enumTitles": [ "Flex (gasoline and ethanol)", "Gasoline", "Diesel", "Hybrid (gasoline and electric)", "Electric", "Ethanol", "Natural gas (GNV)", "Gasoline and natural gas" ] }, "default": [] }, "bodyTypes": { "title": "Body type", "type": "array", "description": "Body styles to include.", "items": { "type": "string", "enum": [ "Utilitário esportivo", "Hatchback", "Sedã", "Picape", "Van/Utilitário", "Minivan", "Cupê", "Conversível", "Perua/SW", "Buggy" ], "enumTitles": [ "SUV", "Hatchback", "Sedan", "Pickup", "Van / utility", "Minivan", "Coupe", "Convertible", "Station wagon", "Buggy" ] }, "default": [] }, "colors": { "title": "Colour", "type": "array", "description": "Exterior colours to include.", "items": { "type": "string", "enum": [ "Branco", "Preto", "Cinza", "Prata", "Azul", "Vermelho", "Verde", "Marrom", "Bege", "Amarelo", "Laranja", "Dourado", "Vinho", "Roxo", "Rosa", "Bronze" ], "enumTitles": [ "White", "Black", "Grey", "Silver", "Blue", "Red", "Green", "Brown", "Beige", "Yellow", "Orange", "Gold", "Wine", "Purple", "Pink", "Bronze" ] }, "default": [] }, "doors": { "title": "Doors", "type": "array", "description": "Number of doors to include.", "items": { "type": "string", "enum": [ "2", "3", "4" ], "enumTitles": [ "2", "3", "4" ] }, "default": [] }, "drivetrains": { "title": "Drivetrain", "type": "array", "description": "Which wheels are driven.", "items": { "type": "string", "enum": [ "Dianteira", "Traseira", "Integral permanente", "Integral parcial" ], "enumTitles": [ "Front-wheel drive", "Rear-wheel drive", "Permanent all-wheel drive", "Part-time all-wheel drive" ] }, "default": [] }, "plateEndings": { "title": "Last plate digit", "type": "array", "description": "Groups of license plate endings (useful for circulation restriction rules).", "items": { "type": "string", "enum": [ "1 e 2", "3 e 4", "5 e 6", "7 e 8", "9 e 0" ], "enumTitles": [ "1 e 2", "3 e 4", "5 e 6", "7 e 8", "9 e 0" ] }, "default": [] }, "minHorsepower": { "title": "Minimum horsepower", "minimum": 0, "type": "integer", "description": "Lowest engine power in cv." }, "maxHorsepower": { "title": "Maximum horsepower", "minimum": 0, "type": "integer", "description": "Highest engine power in cv." }, "minEngineLiters": { "title": "Minimum engine size (liters)", "minimum": 0, "type": "number", "description": "Smallest engine displacement in liters for cars, for example 1.0." }, "maxEngineLiters": { "title": "Maximum engine size (liters)", "minimum": 0, "type": "number", "description": "Largest engine displacement in liters for cars, for example 2.0." }, "minEngineCc": { "title": "Minimum engine size (cc)", "minimum": 0, "type": "integer", "description": "Smallest engine displacement in cubic centimeters (motorcycles)." }, "maxEngineCc": { "title": "Maximum engine size (cc)", "minimum": 0, "type": "integer", "description": "Largest engine displacement in cubic centimeters (motorcycles)." }, "armored": { "title": "Armored", "enum": [ "any", "only", "exclude" ], "type": "string", "description": "Include armored vehicles or not.", "default": "any" }, "auctionHistory": { "title": "Auction history", "enum": [ "any", "exclude", "only" ], "type": "string", "description": "Filter by whether the vehicle passed through an auction.", "default": "any" }, "equipment": { "title": "Equipment (all required)", "type": "array", "description": "Equipment the vehicle must have. When you pick several, every one must be present.", "items": { "type": "string", "enum": [ "Ar condicionado", "Vidros elétricos", "Freio ABS", "Travas elétricas", "Airbag", "Alarme", "Desembaçador traseiro", "Rodas de liga leve", "Ar quente", "Volante com regulagem de altura", "Retrovisores elétricos", "Sensor de estacionamento", "Bancos em couro", "Banco com regulagem de altura", "Limpador traseiro", "Controle de tração", "Encosto de cabeça traseiro", "Direção hidráulica", "Controle automático de velocidade", "GPS", "Rádio", "Teto solar", "Retrovisor fotocrômico", "Sensor de chuva", "Tração 4x4", "Bancos dianteiros com aquecimento", "Farol de xenônio", "CD Player", "Protetor de caçamba", "Capota marítima", "DVD Player" ], "enumTitles": [ "Air conditioning", "Power windows", "ABS brakes", "Power locks", "Airbag", "Alarm", "Rear defogger", "Alloy wheels", "Heater", "Height-adjustable steering wheel", "Power mirrors", "Parking sensor", "Leather seats", "Height-adjustable seat", "Rear wiper", "Traction control", "Rear headrests", "Power steering", "Cruise control", "GPS", "Radio", "Sunroof", "Auto-dimming mirror", "Rain sensor", "4x4", "Heated front seats", "Xenon headlights", "CD player", "Bed protector", "Tonneau cover", "DVD player" ] }, "default": [] }, "highlights": { "title": "Highlights (any)", "type": "array", "description": "Seller-declared highlights. Listings matching at least one are kept.", "items": { "type": "string", "enum": [ "Aceita troca", "IPVA pago", "Licenciado", "Único dono", "Garantia de fábrica", "Todas as revisões feitas pela concessionária", "Todas as revisões feitas pela agenda do carro" ], "enumTitles": [ "Accepts trade-in", "IPVA paid", "Licensed", "Single owner", "Factory warranty", "All services at the dealership", "All services logged in the car agenda" ] }, "default": [] }, "lifestyles": { "title": "Use case", "type": "array", "description": "Webmotors use-case collections such as family cars or first car.", "items": { "type": "string", "enum": [ "Carros para família", "SUVs", "Carros para aplicativos", "Carros econômicos", "Hatches", "Carros populares", "Carros de luxo", "Sedans", "Carros importados", "Carros para PCD", "Primeiro carro", "Picapes", "Carros 4X4", "Carros a diesel", "Carros híbridos", "Carros grandes", "Carros pequenos", "Carros de 7 lugares", "Carros com 2 portas", "Carros esportivos", "Carros para trabalho", "Carros elétricos", "Conversíveis", "Carros antigos", "Carros clássicos" ], "enumTitles": [ "Family cars", "SUVs", "Ride-hailing cars", "Economical cars", "Hatchbacks", "Entry-level cars", "Luxury cars", "Sedans", "Imported cars", "Cars for people with disabilities (PCD)", "First car", "Pickups", "4x4 cars", "Diesel cars", "Hybrid cars", "Large cars", "Small cars", "7-seaters", "2-door cars", "Sports cars", "Work cars", "Electric cars", "Convertibles", "Vintage cars", "Classic cars" ] }, "default": [] }, "sellerTypes": { "title": "Seller type", "type": "array", "description": "Who is selling: franchised dealer, independent store or private person.", "items": { "type": "string", "enum": [ "Concessionária", "Loja", "Pessoa Física" ], "enumTitles": [ "Franchised dealership", "Independent store", "Private seller" ] }, "default": [] }, "sellerIds": { "title": "Seller IDs", "type": "array", "description": "Webmotors seller IDs (the \"sellerId\" field of earlier results) to read one dealer's full stock. Each ID is searched separately.", "default": [], "items": { "type": "string" } }, "maxPerSeller": { "title": "Max listings per seller", "minimum": 1, "type": "integer", "description": "Keep at most this many listings from each seller, so one big dealer does not fill the whole result." }, "opportunities": { "title": "Offers and services", "type": "array", "description": "Keep listings where the seller offers these. When you pick several, all are required.", "items": { "type": "string", "enum": [ "financing", "whatsapp", "quickReply", "tradeWithCash", "carDelivery", "view360", "inspected" ], "enumTitles": [ "Financing available", "WhatsApp contact", "Replies within 24 hours", "Trade-in with cash back", "Car delivery", "360 view", "Inspected (Vistoriado)" ] }, "default": [] }, "onlyWithPhotos": { "title": "Only listings with photos", "type": "boolean", "description": "Skip listings that have no photos.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceAsc", "priceDesc", "yearDesc", "yearAsc", "mileageAsc" ], "type": "string", "description": "Order of results. Relevance is the order Webmotors shows by default.", "default": "relevance" }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of listings to save. Searches with more than 10,000 matches are split into price bands automatically when this is above 9,900. Free plan runs are capped at 25.", "default": 20 }, "includeAllPhotos": { "title": "Include all photo URLs", "type": "boolean", "description": "Add the full list of photo links to every row. The main photo link is always included.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Give a name to turn the run into a monitor. Each run compares with the previous run of the same name and labels listings NEW, PRICE_DROP, PRICE_RISE, UPDATED, UNCHANGED or REMOVED, with price history. Use the same filters and a high \"Max listings\" on a schedule." }, "onlyChanges": { "title": "Only save changes", "type": "boolean", "description": "With a monitor name set, save only new, changed and removed listings and skip unchanged ones.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. By default the actor connects directly and switches to Brazilian residential proxy by itself if Webmotors refuses the connection. Set your own proxy only if you need to.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }