{ "openapi": "3.0.1", "info": { "title": "OLX Brazil Scraper | Listings, Prices & Seller Data", "description": "[💰 $1.0 / 1K] Scrape OLX Brazil listings at scale. Extract titles, prices, descriptions, photos, seller details, location, and category data from Brazil's largest classifieds marketplace by keyword or URL.", "version": "1.1", "x-build-id": "QhBbyF220UFytLERU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~olx-brazil-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-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/solidcode~olx-brazil-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-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/solidcode~olx-brazil-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-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": { "searchUrls": { "title": "Search or Category URLs", "type": "array", "description": "Paste one or more OLX Brazil URLs. For example: https://www.olx.com.br/imoveis/venda/estado-sp or any URL you copied from olx.com.br after applying filters in their site.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Plain-text search terms — for example 'iPhone 13', 'Gol G5', or 'Apartamento'. The scraper will run each query on OLX Brazil and return matching listings.", "items": { "type": "string" } }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of listings to collect across all URLs and queries. Set to 0 for unlimited (capped internally at 50,000 for safety). Note: OLX itself limits results to roughly 5,000 listings per search URL; split larger queries by state or category to scale beyond that.", "default": 100 }, "sortBy": { "title": "Sort Results By", "enum": [ "relevance", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Choose the order in which listings are collected from OLX Brazil. If a Search URL already specifies a sort order (an OLX URL containing sf= or sp=), that URL's sort wins for that URL and this setting is ignored for it.", "default": "relevance" }, "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": "Restrict to listings in one Brazilian state. Applied only to plain-text Search Queries — Search URLs already carry their own state from olx.com.br and take precedence." }, "minPrice": { "title": "Minimum Price (R$)", "minimum": 0, "type": "integer", "description": "Only include listings priced at or above this amount in Brazilian Reais. Native OLX filter — does not cost extra. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum Price (R$)", "minimum": 0, "type": "integer", "description": "Only include listings priced at or below this amount in Brazilian Reais. Native OLX filter — does not cost extra. Leave empty for no maximum." }, "includeBusinessOnly": { "title": "Business Sellers Only", "type": "boolean", "description": "When enabled, only include ads posted by business sellers (lojas / profissionais) and exclude private individuals.", "default": false }, "enrichDetails": { "title": "Fetch Full Description, Seller & Postal Code", "type": "boolean", "description": "When enabled (default), each listing's detail page is fetched to add the full description, seller name, and CEP (postal code) — these aren't in OLX's search response. This roughly doubles the request count per listing, so disable it if you only need title, price, photos, and location.", "default": 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 } } } } } } } } } }