{ "openapi": "3.0.1", "info": { "title": "Otodom Scraper - Polish Real Estate Listings", "description": "Scrapes property listings from Otodom.pl, Poland's leading real estate marketplace. Supports filters for transaction type, property type, location, price, area, rooms, building type, extras, and more.", "version": "1.0", "x-build-id": "zMDVbY3qUiADhKg5T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~otodom-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-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/rigelbytes~otodom-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-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/rigelbytes~otodom-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-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": { "searchUrl": { "title": "Search URL", "type": "string", "description": "Full URL copied from otodom.pl search results. When provided, this URL is preferred and all filter fields below are ignored (only Max Items, Max Pages, and Proxy apply)." }, "locationQuery": { "title": "Location", "type": "string", "description": "City or region name (e.g. 'Bielawa', 'Warszawa') or full Otodom domain path (e.g. 'dolnoslaskie/dzierzoniowski/bielawa/bielawa'). Free-text names are resolved automatically via Otodom autocomplete. Ignored when Search URL is provided." }, "transaction": { "title": "Transaction Type", "enum": [ "SELL", "RENT" ], "type": "string", "description": "For sale or for rent. Ignored when Search URL is provided.", "default": "SELL" }, "estate": { "title": "Property Type", "enum": [ "FLAT", "STUDIO_FLAT", "HOUSE", "INVESTMENT", "ROOM", "TERRAIN", "AGRICULTURAL", "COMMERCIAL_PROPERTY", "HALL", "GARAGE", "OFFICE" ], "type": "string", "description": "Type of property. Ignored when Search URL is provided.", "default": "FLAT" }, "market": { "title": "Market", "enum": [ "ALL", "PRIMARY", "SECONDARY" ], "type": "string", "description": "Primary (new developments) or Secondary (resale). Ignored when Search URL is provided.", "default": "ALL" }, "ownerType": { "title": "Owner Type", "enum": [ "ALL", "PRIVATE", "DEVELOPER", "AGENCY" ], "type": "string", "description": "Filter by seller type. Ignored when Search URL is provided.", "default": "ALL" }, "availability": { "title": "Availability", "enum": [ "", "NOW" ], "type": "string", "description": "When the property is available from. Ignored when Search URL is provided.", "default": "" }, "priceMin": { "title": "Minimum Price (PLN)", "minimum": 0, "type": "integer", "description": "Minimum total price in PLN. Ignored when Search URL is provided." }, "priceMax": { "title": "Maximum Price (PLN)", "minimum": 0, "type": "integer", "description": "Maximum total price in PLN. Ignored when Search URL is provided." }, "areaMin": { "title": "Minimum Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum living area in square meters. Ignored when Search URL is provided." }, "areaMax": { "title": "Maximum Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum living area in square meters. Ignored when Search URL is provided." }, "roomsNumber": { "title": "Number of Rooms", "uniqueItems": true, "type": "array", "description": "Filter by number of rooms. Ignored when Search URL is provided.", "items": { "type": "string", "enum": [ "ONE", "TWO", "THREE", "FOUR", "FIVE", "SIX", "MORE" ], "enumTitles": [ "1", "2", "3", "4", "5", "6", "6+" ] } }, "buildingType": { "title": "Building Type", "uniqueItems": true, "type": "array", "description": "Type of building construction. Ignored when Search URL is provided.", "items": { "type": "string", "enum": [ "BLOCK", "HOUSE", "TENEMENT", "INFILL", "RIBBON", "APARTMENT", "LOFT", "TERRACED", "SEMI_DETACHED", "PREFAB" ], "enumTitles": [ "Apartment block", "House", "Tenement", "Infill", "Ribbon", "Apartment building", "Loft", "Terraced house", "Semi-detached", "Prefabricated" ] } }, "heating": { "title": "Heating", "uniqueItems": true, "type": "array", "description": "Heating type. Ignored when Search URL is provided.", "items": { "type": "string", "enum": [ "URBAN", "TILED_STOVE", "ELECTRICAL", "OTHER", "GAS", "BOILER_ROOM" ], "enumTitles": [ "Urban gas", "Tile stove", "Electric boiler", "Other", "Gas", "Boiler room" ] } }, "floorNumber": { "title": "Floor", "uniqueItems": true, "type": "array", "description": "Floor position of the property. Ignored when Search URL is provided.", "items": { "type": "string", "enum": [ "CELLAR", "GROUND", "FIRST", "SECOND", "THIRD", "FOURTH", "FIFTH", "SIXTH", "SEVENTH", "EIGHTH", "NINTH", "TENTH", "HIGHER", "ATTIC" ], "enumTitles": [ "Basement", "Ground floor", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "Higher than 10", "Attic" ] } }, "floorsNumberMin": { "title": "Min Building Floors", "minimum": 1, "type": "integer", "description": "Minimum number of floors in the building. Ignored when Search URL is provided." }, "floorsNumberMax": { "title": "Max Building Floors", "minimum": 1, "type": "integer", "description": "Maximum number of floors in the building. Ignored when Search URL is provided." }, "buildYearMin": { "title": "Year Built (From)", "minimum": 1800, "maximum": 2026, "type": "integer", "description": "Minimum construction year. Ignored when Search URL is provided." }, "buildYearMax": { "title": "Year Built (To)", "minimum": 1800, "maximum": 2026, "type": "integer", "description": "Maximum construction year. Ignored when Search URL is provided." }, "extras": { "title": "Extras / Amenities", "uniqueItems": true, "type": "array", "description": "Property amenities (multi-select). Ignored when Search URL is provided.", "items": { "type": "string", "enum": [ "BALCONY", "TERRACE", "GARAGE", "PARKING_SPACE", "GARDEN", "BASEMENT", "SEPARATE_KITCHEN", "LIFT", "TWO_STOREY", "AIR_CONDITIONING", "UTILITY_ROOM", "FURNISHED", "SECURITY", "MONITORING" ], "enumTitles": [ "Balcony", "Terrace", "Garage", "Parking space", "Garden", "Basement", "Separate kitchen", "Elevator", "Two-storey", "Air conditioning", "Utility room", "Furnished", "Security", "Monitoring" ] } }, "daysSinceCreated": { "title": "Listing Age", "enum": [ "", "1", "3", "7", "14", "30" ], "type": "string", "description": "Filter listings by how recently they were posted. Ignored when Search URL is provided.", "default": "" }, "hasPhotos": { "title": "Only with Photos", "type": "boolean", "description": "Only show listings that have photos. Ignored when Search URL is provided.", "default": false }, "isExclusiveOffer": { "title": "Only Exclusive Offers", "type": "boolean", "description": "Only show exclusive offers (private listings). Ignored when Search URL is provided.", "default": false }, "sortBy": { "title": "Sort By", "enum": [ "DEFAULT", "PRICE", "DATE", "AREA" ], "type": "string", "description": "How to sort the results. Ignored when Search URL is provided.", "default": "DEFAULT" }, "sortDirection": { "title": "Sort Direction", "enum": [ "DESC", "ASC" ], "type": "string", "description": "Ascending or descending order. Ignored when Search URL is provided.", "default": "DESC" }, "maxPages": { "title": "Max Pages", "minimum": 0, "type": "integer", "description": "Maximum number of result pages to scrape (0 = unlimited, ~36 listings per page). maxItems takes precedence.", "default": 0 }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of listings to scrape (0 = unlimited). Takes precedence over maxPages.", "default": 100 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for anti-bot protection", "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 } } } } } } } } } }