{ "openapi": "3.0.1", "info": { "title": "OLX Brazil Scraper | Listings, Prices & Photos", "description": "Scrape OLX Brazil listings by search URL or keyword. Get BRL prices, locations, attributes and photos, with optional listing details and seller profile enrichment. Export JSON, CSV or Excel. Pay per saved listing; profile enrichment is an optional extra charge.", "version": "0.9", "x-build-id": "EV5A9SAcOdO6VmXtX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datascraperes~olx-brazil-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datascraperes-olx-brazil-listings-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/datascraperes~olx-brazil-listings-scraper/runs": { "post": { "operationId": "runs-sync-datascraperes-olx-brazil-listings-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/datascraperes~olx-brazil-listings-scraper/run-sync": { "post": { "operationId": "run-sync-datascraperes-olx-brazil-listings-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": "OLX search URLs", "maxItems": 1000, "uniqueItems": true, "type": "array", "description": "Paste search-result URLs copied from OLX Brazil to keep your category, location and filters. Replace the example URL with your own, or remove it when searching only by keyword.", "items": { "type": "string", "pattern": "^https?://([A-Za-z0-9-]+\\.)*olx\\.com\\.br/" } }, "searchQueries": { "title": "Search queries", "maxItems": 1000, "uniqueItems": true, "type": "array", "description": "Optional keywords searched across Brazil, for example iphone or apartamento. When URLs are also entered, both sets of searches run. Clear the example URL for a keyword-only search.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "maxResults": { "title": "Maximum listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard limit for unique listings saved across the whole run.", "default": 100 }, "maxPagesPerSearch": { "title": "Maximum pages per source", "minimum": 1, "maximum": 20, "type": "integer", "description": "Follow OLX's next-page link up to this many pages for each search URL or generated query URL.", "default": 1 }, "maxPagesTotal": { "title": "Maximum pages per run", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Global safety limit for pages requested across all search URLs and generated query URLs. Use this to control runtime and request volume for large batches.", "default": 1000 }, "includeDetails": { "title": "Fetch listing details", "type": "boolean", "description": "Add available listing descriptions, additional photos, basic seller information and postal location from the listing page. Profile endpoint enrichment is a separate optional setting.", "default": false }, "enrichProfiles": { "title": "Enrich seller profiles (extra charge by plan)", "type": "boolean", "description": "Optional extra charge per unique seller profile per run: Free $0.001, Bronze $0.0009, Silver $0.0008, Gold/Platinum/Diamond $0.00075 when useful profile data with a public seller ID is saved. Partial profiles are billable; empty, blocked and unidentified profiles are not. Works independently of listing details. Disabled by default.", "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 } } }, "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 } } } } } } } } } }