{ "openapi": "3.0.1", "info": { "title": "Otodom Scraper — Poland Real Estate Listings", "description": "Scrape Polish property listings from Otodom.pl: apartments, houses, plots, rooms and commercial for sale or rent. Price, price per m², rent (czynsz), area, rooms, floor, voivodeship, city, district, street, features, agency or private owner, photos, dates. Export CSV/JSON.", "version": "1.0", "x-build-id": "w3wc68LHysk5gBZmB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hipersoft~otodom-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hipersoft-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/hipersoft~otodom-scraper/runs": { "post": { "operationId": "runs-sync-hipersoft-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/hipersoft~otodom-scraper/run-sync": { "post": { "operationId": "run-sync-hipersoft-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": { "transaction": { "title": "Transaction", "enum": [ "sprzedaz", "wynajem" ], "type": "string", "description": "Sale or rent.", "default": "sprzedaz" }, "propertyType": { "title": "Property type", "enum": [ "mieszkanie", "dom", "dzialka", "lokal", "pokoj", "haleimagazyny", "garaz" ], "type": "string", "description": "Type of property.", "default": "mieszkanie" }, "cities": { "title": "Cities", "type": "array", "description": "Polish cities: Warszawa, Kraków, Wrocław, Gdańsk, Gdynia, Poznań, Łódź, Katowice, Szczecin, Lublin, Białystok, Rzeszów, Toruń, Bydgoszcz, Kielce, Olsztyn, Opole. For other places use Location paths or paste Otodom links.", "items": { "type": "string" } }, "locationPaths": { "title": "Location paths (advanced)", "type": "array", "description": "Otodom location paths from the site URL, e.g. mazowieckie/warszawa/warszawa/warszawa/mokotow or pomorskie/sopot/sopot/sopot.", "items": { "type": "string" } }, "startUrls": { "title": "Otodom search links", "type": "array", "description": "Optional Otodom results links with any filters (overrides the fields above).", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price (PLN)", "minimum": 0, "type": "integer", "description": "Minimum total price or rent." }, "maxPrice": { "title": "Maximum price (PLN)", "minimum": 0, "type": "integer", "description": "Maximum total price or rent." }, "minArea": { "title": "Minimum area (m²)", "minimum": 0, "type": "integer", "description": "Minimum area." }, "maxArea": { "title": "Maximum area (m²)", "minimum": 0, "type": "integer", "description": "Maximum area." }, "maxItems": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Stop after this many listings (0 = no limit).", "default": 200 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed in most cases.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }