{ "openapi": "3.0.1", "info": { "title": "Otodom.pl Scraper", "description": "Scrape property listings from Otodom.pl, Poland's largest real estate portal. Extract prices, area, rooms, location, agency info, and images for sale and rental listings.", "version": "1.0", "x-build-id": "Otipy9nZGCyYOS364" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~otodom-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-otodom-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/parsebird~otodom-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-otodom-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/parsebird~otodom-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-otodom-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct Otodom.pl URLs to scrape — search result pages (otodom.pl/pl/wyniki/...) or single offer pages (otodom.pl/pl/oferta/...). When set, the search filters below are ignored.", "items": { "type": "string" }, "default": [] }, "searchType": { "title": "Search Type", "enum": [ "sprzedaz", "wynajem" ], "type": "string", "description": "Sale (sprzedaż) or rental (wynajem) listings.", "default": "sprzedaz" }, "propertyType": { "title": "Property Type", "enum": [ "mieszkanie", "dom", "dzialka", "lokal", "haleimagazyny", "garaz" ], "type": "string", "description": "Category of property to search for.", "default": "mieszkanie" }, "location": { "title": "Location", "type": "string", "description": "Location path as used in Otodom URLs: voivodeship, or voivodeship/city (e.g. mazowieckie, mazowieckie/warszawa, malopolskie/krakow). Leave empty to search all of Poland.", "default": "" }, "priceMin": { "title": "Min Price (PLN)", "minimum": 0, "type": "integer", "description": "Minimum price in PLN. Leave empty for no minimum." }, "priceMax": { "title": "Max Price (PLN)", "minimum": 0, "type": "integer", "description": "Maximum price in PLN. Leave empty for no maximum." }, "areaMin": { "title": "Min Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum property area in square meters. Leave empty for no minimum." }, "areaMax": { "title": "Max Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum property area in square meters. Leave empty for no maximum." }, "roomsMin": { "title": "Min Rooms", "minimum": 1, "maximum": 6, "type": "integer", "description": "Minimum number of rooms (1-6, where 6 means '6 or more')." }, "roomsMax": { "title": "Max Rooms", "minimum": 1, "maximum": 6, "type": "integer", "description": "Maximum number of rooms (1-6, where 6 means '6 or more')." }, "buildYear": { "title": "Min Construction Year", "minimum": 1900, "type": "integer", "description": "Only include properties built in this year or later." }, "market": { "title": "Market", "enum": [ "ALL", "PRIMARY", "SECONDARY" ], "type": "string", "description": "Filter by primary (new/developer) or secondary market.", "default": "ALL" }, "postedDate": { "title": "Posted Within", "enum": [ "", "1", "3", "7", "14" ], "type": "string", "description": "Only include listings posted within the last N days.", "default": "" }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of property listings to scrape. Set to 0 for unlimited.", "default": 50 }, "extractDetails": { "title": "Extract Full Details", "type": "boolean", "description": "Visit each property's offer page to extract full details (description, features, images, build year, seller phone). Slower and uses more compute; turn off for a fast listing-only scrape.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum number of parallel requests when extracting offer page details.", "default": 5 }, "maxRequestRetries": { "title": "Max Request Retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a failed request before giving up on it.", "default": 3 }, "maxRequestsPerMinute": { "title": "Max Requests Per Minute", "minimum": 1, "maximum": 300, "type": "integer", "description": "Rate limit applied across all requests to Otodom.pl.", "default": 60 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the scraper. Otodom.pl blocks Apify's shared datacenter proxy IPs, so residential proxies are used by default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }