{ "openapi": "3.0.1", "info": { "title": "Otodom Scraper - Polish Real Estate Listings", "description": "Scrape verified Otodom.pl listings for sale or rent using structured filters. Get compact prices, areas, rooms and locations, plus details and raw data.", "version": "2.0", "x-build-id": "TdLWGlqmE4rhJ0Zno" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ziomixshot~otodom-pl-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ziomixshot-otodom-pl-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/ziomixshot~otodom-pl-scraper/runs": { "post": { "operationId": "runs-sync-ziomixshot-otodom-pl-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/ziomixshot~otodom-pl-scraper/run-sync": { "post": { "operationId": "run-sync-ziomixshot-otodom-pl-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": { "locationQuery": { "title": "Location", "type": "string", "description": "Polish city, district or region, for example Warszawa or Kraków. Leave empty only for a bounded demo run." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many unique listings. Use it to cap both the result size and listing charges." }, "enrichDetails": { "title": "Enrich with offer details", "type": "boolean", "description": "Fetch each offer page and add full details. This adds a separate listing-details charge; phone numbers are never collected.", "default": false }, "includeRawData": { "title": "Include raw diagnostic data", "type": "boolean", "description": "Add unstable raw and detailRaw source objects. Keep disabled for the compact normalized v2 output.", "default": false }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "Scrape returns matching listings. Monitor returns only listing IDs not seen in earlier runs that use the same key-value store.", "default": "scrape" }, "searchingCriteria": { "title": "Searching criteria path", "type": "string", "description": "Paste the path after /pl/wyniki/ when you already know it, for example sprzedaz/mieszkanie/malopolskie/krakow/krakow/krakow. Takes priority over Location query." }, "estate": { "title": "Estate type", "enum": [ "FLAT", "STUDIO_FLAT", "HOUSE", "ROOM", "TERRAIN", "COMMERCIAL_PROPERTY", "HALL", "GARAGE", "OFFICE", "BUILDING" ], "type": "string", "description": "Property category (used when building path from locationQuery / defaults).", "default": "FLAT" }, "transaction": { "title": "Transaction", "enum": [ "SELL", "RENT" ], "type": "string", "description": "SELL (sprzedaż) or RENT (wynajem).", "default": "SELL" }, "priceMin": { "title": "Price min (PLN)", "minimum": 0, "type": "integer", "description": "Minimum listing price in PLN." }, "priceMax": { "title": "Price max (PLN)", "minimum": 0, "type": "integer", "description": "Maximum price filter in PLN (passed to wyniki query)." }, "areaMin": { "title": "Area min (m²)", "minimum": 0, "type": "number", "description": "Minimum area in square meters." }, "areaMax": { "title": "Area max (m²)", "minimum": 0, "type": "number", "description": "Maximum area in square meters." }, "roomsNumber": { "title": "Rooms", "type": "array", "description": "Otodom roomsNumber enum values.", "items": { "type": "string", "enum": [ "ONE", "TWO", "THREE", "FOUR", "FIVE", "SIX_OR_MORE" ] } }, "market": { "title": "Market", "enum": [ "ALL", "PRIMARY", "SECONDARY" ], "type": "string", "description": "ALL / PRIMARY (primary market / developer) / SECONDARY.", "default": "ALL" }, "buildingType": { "title": "Building type", "type": "array", "description": "Depends on estate (flat: BLOCK, TENEMENT, …; house: DETACHED, …).", "items": { "type": "string", "enum": [ "BLOCK", "TENEMENT", "HOUSE", "INFILL", "RIBBON", "APARTMENT", "LOFT", "OTHER", "DETACHED", "SEMI_DETACHED", "RESIDENCE", "FARM" ] } }, "sortBy": { "title": "Sort by", "enum": [ "DEFAULT", "LATEST", "PRICE", "AREA" ], "type": "string", "description": "Sort field for wyniki listing.", "default": "DEFAULT" }, "sortDirection": { "title": "Sort direction", "enum": [ "ASC", "DESC" ], "type": "string", "description": "Sort direction (ASC or DESC).", "default": "DESC" }, "ownerTypeSingleSelect": { "title": "Owner type", "enum": [ "ALL", "PRIVATE", "AGENCY", "DEVELOPER" ], "type": "string", "description": "Filter by owner type: ALL, PRIVATE, AGENCY, or DEVELOPER.", "default": "ALL" }, "daysSinceCreated": { "title": "Days since created", "minimum": 1, "type": "integer", "description": "Only ads created within the last N days." }, "seenStoreName": { "title": "Seen-IDs store name", "type": "string", "description": "Named Key-Value store shared by monitor runs. Use a separate name per search. Empty uses the run's default store and does not persist history across independent runs." }, "seenIdsKey": { "title": "Seen-IDs KV key", "type": "string", "description": "Key inside the store holding { ids: string[], updatedAt, … }.", "default": "OTODOM_SEEN_IDS" }, "stopMonitorOnAllSeenPages": { "title": "Stop after N all-seen pages", "minimum": 1, "type": "integer", "description": "In monitor mode, stop when this many consecutive pages contain only already-seen ad IDs (default 1).", "default": 1 }, "startUrls": { "title": "Start URLs (advanced)", "type": "array", "description": "Optional copied Otodom result URLs. A provided URL owns its complete search and takes priority over all structured search fields.", "items": { "type": "string" } }, "countOnly": { "title": "Count only", "type": "boolean", "description": "Estimate how many listings match the search without collecting or charging for listing rows.", "default": false }, "limit": { "title": "Items per page", "type": "integer", "description": "Number of listings requested per Otodom page. The Actor accepts 36, 48 or 72 and uses 72 by default.", "default": 72 }, "maxPages": { "title": "Max pages", "minimum": 1, "type": "integer", "description": "Stop each search after this many Otodom result pages." }, "proxyConfiguration": { "title": "Proxy configuration (locked)", "type": "object", "description": "Hard-locked to Apify RESIDENTIAL proxies with country PL. Datacenter proxies (~47% success) are not allowed — the Actor always uses residential PL. This field is hidden in the UI; overrides in API input are ignored.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "PL" } } } }, "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 } } } } } } } } } }