{ "openapi": "3.0.1", "info": { "title": "๐Ÿš€ OLX Brazil Scraper ยท 10,000 Free Listings/Month", "description": "OLX Brazil Scraper gets you olx.com.br ads โšก fast, ๐ŸŽฏ 100% accurate and ๐Ÿ” ridiculously detailed โ€” prices, photos, specs, CEP, sellers & FIPE values. ๐Ÿ’ฐ $0.50 per 1,000 listings, no start fee. Scrape your first 10,000 listings free every month ๐Ÿš€", "version": "0.0", "x-build-id": "tBKacfGJRiaeaLEew" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omkar-cloud~olx-brazil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omkar-cloud-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/omkar-cloud~olx-brazil-scraper/runs": { "post": { "operationId": "runs-sync-omkar-cloud-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/omkar-cloud~olx-brazil-scraper/run-sync": { "post": { "operationId": "run-sync-omkar-cloud-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 Keywords", "type": "array", "description": "Keywords to search โ€” each is searched separately. Rows carry a `query` field so you can tell keywords apart. Leave empty to scrape a whole category or location, or only URLs.", "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "OLX category path or code โ€” e.g. `autos-e-pecas/carros-vans-e-utilitarios` (cars), `autos-e-pecas/motos`, `imoveis/venda` (homes for sale), `imoveis/aluguel` (rentals), `celulares` (phones) or `3060`. Copy any category path from an olx.com.br URL. Leave empty for every category." }, "location": { "title": "Location", "type": "string", "description": "Where to search: a state code (`sp`, `rj`), a city name (`Campinas`, `Belo Horizonte`), a neighbourhood with its city (`Copacabana Rio de Janeiro`) or an olx.com.br location path (`estado-sp/sao-paulo-e-regiao`). The run log shows which place was picked. Leave empty for all of Brazil." }, "startUrls": { "title": "OLX Brazil URLs", "type": "array", "description": "Search page and/or ad URLs โ€” you can mix them. Ad pages are always scraped with full details (billed at the detailed rate).", "items": { "type": "string" } }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "newest", "lowest_price" ], "type": "string", "description": "Order of search results.", "default": "relevance" }, "sellerType": { "title": "Seller Type", "enum": [ "", "private", "professional" ], "type": "string", "description": "Only private sellers or only professional (business) sellers.", "default": "" }, "condition": { "title": "Condition", "enum": [ "", "new", "used_excellent", "used_good", "refurbished", "defective" ], "type": "string", "description": "Item condition (electronics categories).", "default": "" }, "minPrice": { "title": "Minimum Price (R$)", "minimum": 0, "type": "integer", "description": "Lowest asking price in BRL." }, "maxPrice": { "title": "Maximum Price (R$)", "minimum": 0, "type": "integer", "description": "Highest asking price in BRL." }, "onlyGoodSellers": { "title": "Top-Rated Sellers Only", "type": "boolean", "description": "Only ads from sellers rated above 4 stars.", "default": false }, "postedWithinDays": { "title": "Posted Within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only ads posted in the last N days. Searches run newest-first and stop at the cutoff, so you never pay for older ads." }, "yearMin": { "title": "Model Year โ€” From", "minimum": 1950, "maximum": 2100, "type": "integer", "description": "Earliest model year." }, "yearMax": { "title": "Model Year โ€” To", "minimum": 1950, "maximum": 2100, "type": "integer", "description": "Latest model year." }, "mileageMax": { "title": "Maximum Mileage (km)", "minimum": 0, "type": "integer", "description": "Highest mileage in km." }, "gearbox": { "title": "Gearbox", "enum": [ "", "manual", "automatic", "semi_automatic", "automated" ], "type": "string", "description": "Gearbox type.", "default": "" }, "fuel": { "title": "Fuel", "enum": [ "", "gasoline", "ethanol", "flex", "diesel", "hybrid", "electric" ], "type": "string", "description": "Fuel type.", "default": "" }, "rooms": { "title": "Bedrooms", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of bedrooms (5 = five or more)." }, "bathrooms": { "title": "Bathrooms", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of bathrooms (5 = five or more)." }, "garageSpaces": { "title": "Parking Spaces", "minimum": 0, "maximum": 5, "type": "integer", "description": "Parking spaces (5 = five or more)." }, "sizeMin": { "title": "Minimum Area (mยฒ)", "minimum": 0, "type": "integer", "description": "Smallest area in mยฒ." }, "sizeMax": { "title": "Maximum Area (mยฒ)", "minimum": 0, "type": "integer", "description": "Largest area in mยฒ." }, "extraFilters": { "title": "More OLX Filters", "type": "string", "description": "Any other OLX filter as `key=value` pairs, comma-separated โ€” copy them from an olx.com.br search URL, e.g. `cf=5,ctp=9` (car options and body type)." }, "maxResultsPerSearch": { "title": "Max Ads per Search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of ads per keyword or search URL. Use this to control your cost (1,000 ads โ‰ˆ $0.50). OLX shows at most 5,000 ads per search. Ignored for ad URLs.", "default": 100 }, "scrapeAdDetails": { "title": "Scrape Full Ad Details", "type": "boolean", "description": "When enabled, every search result is also scraped in full โ€” description, CEP, seller profile (name, verifications, sales), masked phone, every photo and video, car financing, FIPE value and market price range, real-estate condo fee and IPTU, OLX Pay installments. Still one row per ad, billed at the detailed rate ($2.00 per 1,000 instead of $0.50). Runs take longer because each ad page is fetched.", "default": 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 } } } } } } } } } }