{ "openapi": "3.0.1", "info": { "title": "OLX Scraper | Ads, Prices & Cities", "description": "Scrape OLX guest classifieds from olx.com.br: keyword search, São Paulo or nationwide, cell-phone category pages, and listing detail. Get listId, title, BRL price, city, UF, images and category. Export Excel, CSV or JSON. No seller name, phone, or chat.", "version": "0.1", "x-build-id": "0uykGYU3unRYpEP2R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~olx-br-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-olx-br-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/lentic_clockss~olx-br-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-olx-br-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/lentic_clockss~olx-br-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-olx-br-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": { "query": { "title": "Search query", "type": "string", "description": "Keyword for searchType=search. Default sofa so empty {} and query=\"\" hit /brasil?q=sofa (home without q= is not a list). Not iphone/celulares.", "default": "sofa" }, "searchType": { "title": "Search type", "enum": [ "search", "category", "detail", "hub", "vehicles", "realestate", "seller", "home", "other-country" ], "type": "string", "description": "Opened: search, category (/celulares), detail. hub discovers href leaf slugs and is not a list. vehicles / realestate / seller / home / other-country fail-fast.", "default": "search" }, "region": { "title": "Region path", "enum": [ "brasil", "estado-ac", "estado-al", "estado-ap", "estado-am", "estado-ba", "estado-ce", "estado-df", "estado-es", "estado-go", "estado-ma", "estado-mt", "estado-ms", "estado-mg", "estado-pa", "estado-pb", "estado-pr", "estado-pe", "estado-pi", "estado-rj", "estado-rn", "estado-rs", "estado-ro", "estado-rr", "estado-sc", "estado-sp", "estado-se", "estado-to" ], "type": "string", "description": "Market switch is a path, not state= query. Cloud Run opened: brasil, estado-sp. Other UFs including estado-mg and estado-rj fail-fast until measured.", "default": "brasil" }, "categorySlug": { "title": "Leaf category slug", "type": "string", "description": "Required for searchType=category. Opened leaf: celulares. Other leaves and hubs (eletronicos-e-celulares, autos-e-pecas, imoveis) fail-fast. searchType=hub returns discoveredLeaves from hrefs instead of listings.", "default": "" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap dataset rows (1–200). Console Test / empty {} default is 1. Free-plan users are capped by the Actor.", "default": 1 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "Pagination key o= from 1. About 50 cards/page. Capped at 8; enrichDetails clamps to 3 so the 850s worker timeout is not exhausted.", "default": 1 }, "enrichDetails": { "title": "Follow listing URLs", "type": "boolean", "description": "If true, GET each ads[].url and merge adDetail / JSON-LD price. List priceValue and detail offerPrice can differ — both are kept. Clamps maxPages to 3 so the worker timeout is not exhausted.", "default": false }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "Full {uf}.olx.com.br listing URLs ending in -{listId}. Do not pass /vi/{id} home recommend cards or invent adId URLs.", "items": { "type": "string" }, "default": [] }, "priceMin": { "title": "Min price (BRL)", "minimum": 0, "type": "integer", "description": "Optional list filter query ps=. Side-evidence in recon; only use when you need a price floor." }, "priceMax": { "title": "Max price (BRL)", "minimum": 0, "type": "integer", "description": "Optional list query pe=." }, "sort": { "title": "Sort", "type": "string", "description": "Optional sort query. Omit for site default (relevance).", "default": "" }, "workerBaseUrl": { "title": "Worker base URL override", "type": "string", "description": "Optional. HTTPS Cloud Run origin only (*.run.app). Auth is never sent to arbitrary hosts. Production uses Actor env WORKER_BASE_URL.", "default": "" } } }, "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 } } } } } } } } } }