{ "openapi": "3.0.1", "info": { "title": "OLX Imóveis Scraper | Brazil Apartments, Rent & Prices", "description": "The OLX Brazil Real Estate Scraper extracts OLX Imóveis apartments, houses, land and commercial property for sale or rent: price, m², bedrooms, bathrooms, garage, condo fee, IPTU, city and neighbourhood, with optional CEP, coordinates and advertiser. Ideal for property market research.", "version": "0.0", "x-build-id": "vBewOMIuFLHm66zQh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piotrv1001~olx-brazil-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piotrv1001-olx-brazil-real-estate-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/piotrv1001~olx-brazil-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-piotrv1001-olx-brazil-real-estate-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/piotrv1001~olx-brazil-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-piotrv1001-olx-brazil-real-estate-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": { "dealType": { "title": "Deal type", "enum": [ "sale", "rent" ], "type": "string", "description": "For sale or for rent.", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "any", "apartment", "house", "land", "commercial" ], "type": "string", "description": "Which kind of property to search.", "default": "apartment" }, "state": { "title": "State", "enum": [ "all", "ac", "al", "am", "ap", "ba", "ce", "df", "es", "go", "ma", "mg", "ms", "mt", "pa", "pb", "pe", "pi", "pr", "rj", "rn", "ro", "rr", "rs", "sc", "se", "sp", "to" ], "type": "string", "description": "State to search. For one city, paste a search link below.", "default": "sp" }, "keyword": { "title": "Keyword", "type": "string", "description": "Optional words to look for, for example piscina or cobertura." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 5, "type": "integer", "description": "At least this many bedrooms (5 means 5 or more)." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 5, "type": "integer", "description": "At most this many bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 5, "type": "integer", "description": "At least this many bathrooms." }, "minGarageSpaces": { "title": "Min garage spaces", "minimum": 0, "maximum": 5, "type": "integer", "description": "At least this many garage spaces." }, "minSizeM2": { "title": "Min size (m²)", "minimum": 0, "type": "integer", "description": "Only properties of at least this size." }, "maxSizeM2": { "title": "Max size (m²)", "minimum": 0, "type": "integer", "description": "Only properties up to this size." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "cheapest", "priciest" ], "type": "string", "description": "Order of the results.", "default": "relevance" }, "minPrice": { "title": "Min price (R$)", "minimum": 0, "type": "integer", "description": "Only ads priced at this amount or more." }, "maxPrice": { "title": "Max price (R$)", "minimum": 0, "type": "integer", "description": "Only ads priced at this amount or less." }, "sellerType": { "title": "Seller type", "enum": [ "any", "private", "professional" ], "type": "string", "description": "Private sellers, professional sellers, or both.", "default": "any" }, "startUrls": { "title": "Search links", "type": "array", "description": "Search or category links copied from www.olx.com.br with any filters, for example https://www.olx.com.br/imoveis/venda/apartamentos/estado-sp/vale-do-paraiba-e-litoral-norte/sao-jose-dos-campos. When you paste links, the fields above are ignored.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many properties in total. Your maximum charge per run also caps the run. Above 5,000, searches are split by state and price band automatically; ads with no price can then be missed.", "default": 50 }, "scrapeDetails": { "title": "Scrape ad details", "type": "boolean", "description": "Also open each ad for the full description, first-listed date, CEP, coordinates and seller name. Charged per ad on top of the property price.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies in Brazil work best.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } } }, "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 } } } } } } } } } }