{ "openapi": "3.0.1", "info": { "title": "Otodom Scraper | Poland Property Listings", "description": "Extract Polish property listings, prices in PLN, rooms, floor area, public contacts and company profiles from Otodom. Pay per delivered row plus a run start fee.", "version": "0.1", "x-build-id": "uL8sxLGOMzed0Ze32" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~otodom-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-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/lentic_clockss~otodom-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-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/lentic_clockss~otodom-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-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": { "location": { "title": "City / location", "maxLength": 240, "type": "string", "description": "Polish city (warszawa), voivodeship (mazowieckie), full path, or polska for the whole country. Leave empty when you fill Detail URLs, a developer or an agency." }, "locations": { "title": "Extra locations", "type": "array", "description": "Additional Polish places to search. Results are combined with location and duplicate entities are removed.", "items": { "type": "string" } }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "Otodom listing links (/pl/oferta/…) or developer links. Each link is one input.", "items": { "type": "string" } }, "channel": { "title": "Channel", "enum": [ "auto", "sale", "rent", "developer", "agency" ], "type": "string", "description": "Auto picks the channel from what you fill: listing links, a developer, an agency, or a place (a place alone searches listings for sale). Choose For rent to search rentals.", "default": "auto" }, "developerUrl": { "title": "Developer URL", "pattern": "^$|^/|^https?://([A-Za-z0-9-]+\\.)*otodom\\.pl(/.*)?$", "type": "string", "description": "Otodom developer profile URL or site-relative path. Use this instead of developerSlug and developerId when you have the full link." }, "developerId": { "title": "Developer ID", "type": "string", "description": "Developer identifier from the profile URL. Pair it with developerSlug when available." }, "developerSlug": { "title": "Developer slug", "type": "string", "description": "Developer profile URL slug, with or without its ID suffix. A complete developerUrl is recommended." }, "agencyUrl": { "title": "Agency URL", "pattern": "^$|^/|^https?://([A-Za-z0-9-]+\\.)*otodom\\.pl(/.*)?$", "type": "string", "description": "Otodom real estate agency profile URL or site-relative path. Use this instead of agencySlug and agencyId when you have the full link." }, "agencyId": { "title": "Agency ID", "type": "string", "description": "Agency identifier from the profile URL. Pair it with agencySlug when available." }, "agencySlug": { "title": "Agency slug", "type": "string", "description": "Agency profile URL slug, with or without its ID suffix. A complete agencyUrl is recommended." }, "maxResults": { "title": "Max rows per location or URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Most rows for each location, detail URL, or developer input. Default 70; larger numbers are collected in parts of 70. All row types count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor (limits set by the Actor developer).", "default": 70 }, "propertyType": { "title": "Property type", "enum": [ "mieszkanie", "dom", "dzialka", "lokal", "pokoj", "garaz", "inwestycja" ], "type": "string", "description": "Property category to search: apartment, house, land, commercial property, room, garage or investment.", "default": "mieszkanie" }, "market": { "title": "Market", "enum": [ "ALL", "PRIMARY", "SECONDARY" ], "type": "string", "description": "Choose all properties, primary-market properties or secondary-market properties.", "default": "ALL" }, "sortBy": { "title": "Sort by", "enum": [ "", "DEFAULT", "PRICE", "AREA", "DATE" ], "type": "string", "description": "Sort search listings by the site default, price, area or date.", "default": "" }, "sortDirection": { "title": "Sort direction", "enum": [ "", "ASC", "DESC" ], "type": "string", "description": "Choose ascending or descending order when sortBy is set.", "default": "" }, "minPrice": { "title": "Min price (PLN)", "minimum": 0, "type": "integer", "description": "Minimum listing price filter (PLN)." }, "maxPrice": { "title": "Max price (PLN)", "minimum": 0, "type": "integer", "description": "Maximum listing price filter (PLN)." }, "minArea": { "title": "Min area (m²)", "minimum": 0, "type": "number", "description": "Minimum living area in square meters." }, "maxArea": { "title": "Max area (m²)", "minimum": 0, "type": "number", "description": "Maximum living area in square meters." }, "rooms": { "title": "Rooms", "type": "string", "description": "Room count from 1 to 6, or ONE to SIX. Leave empty to include all room counts.", "default": "" }, "privateOnly": { "title": "Private owners only", "type": "boolean", "description": "Keep listings marked as private-owner offers rather than agency offers.", "default": false }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Retained for compatibility. Current search pagination is automatic; use maxResults to limit delivered rows.", "default": 1 }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Add available detail information to listing rows. Enabled in the input form; set true explicitly in API input to request enrichment.", "default": true }, "includeRaw": { "title": "Include source data", "type": "boolean", "description": "Include source data in raw. Large values are shortened to a size-limited preview.", "default": false }, "workerBaseUrl": { "title": "Developer testing setting", "pattern": "^(https://worker\\.opendata\\.best/b/otodom-pl/?)?$", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "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 }, "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 } } } } } } } } } }