{ "openapi": "3.0.1", "info": { "title": "Global Real Estate New Listing Monitor", "description": "Watches Rightmove, Idealista, Immowelt, willhaben and Kleinanzeigen and returns only new listings — with photos and webhook alerts. Built for scheduled worldwide monitoring.", "version": "0.1", "x-build-id": "V8dpochYu3GduKkC1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mocha_tassel~global-listing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mocha_tassel-global-listing-monitor", "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/mocha_tassel~global-listing-monitor/runs": { "post": { "operationId": "runs-sync-mocha_tassel-global-listing-monitor", "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/mocha_tassel~global-listing-monitor/run-sync": { "post": { "operationId": "run-sync-mocha_tassel-global-listing-monitor", "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", "required": [ "portal" ], "properties": { "portal": { "title": "Portal", "enum": [ "rightmove", "idealista", "immowelt", "willhaben", "kleinanzeigen" ], "type": "string", "description": "Which portal to watch. Rightmove and Idealista almost always need a Search URL plus residential proxies from the matching country.", "default": "rightmove" }, "searchUrl": { "title": "Search URL (recommended)", "type": "string", "description": "Paste any search URL from the portal after you applied filters in the browser. Required for Idealista; strongly recommended for Rightmove." }, "location": { "title": "Location", "type": "string", "description": "For Rightmove: a UK place name (resolved via typeahead) or a locationIdentifier such as REGION^87490. For Immowelt/willhaben: a city name. Ignored when Search URL is set.", "default": "London" }, "offerType": { "title": "Buy or rent", "enum": [ "buy", "rent" ], "type": "string", "description": "Whether to watch properties for sale or for rent.", "default": "buy" }, "estateType": { "title": "Property type (Immowelt)", "enum": [ "apartment", "house", "land", "apartment-house" ], "type": "string", "description": "Applies to Immowelt only.", "default": "apartment" }, "category": { "title": "Category (willhaben / Kleinanzeigen)", "type": "string", "description": "Portal-specific category slug, for example eigentumswohnung or mietwohnung.", "default": "eigentumswohnung" }, "locationSlug": { "title": "Location slug (Kleinanzeigen)", "type": "string", "description": "Kleinanzeigen URL slug for the area, copied from the portal search URL." }, "locationCode": { "title": "Location code (Kleinanzeigen)", "type": "string", "description": "Kleinanzeigen numeric location code, copied from the portal search URL." }, "maxItems": { "title": "Listings to check per run", "minimum": 10, "maximum": 2000, "type": "integer", "description": "How many listings the monitor scans each run. Higher is more thorough but slower and more expensive.", "default": 200 }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Ignore listings cheaper than this amount. Currency follows the portal." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Ignore listings more expensive than this amount. Currency follows the portal." }, "minArea": { "title": "Minimum living area (m²)", "type": "integer", "description": "Ignore listings smaller than this living area in square metres." }, "maxArea": { "title": "Maximum living area (m²)", "type": "integer", "description": "Ignore listings larger than this living area in square metres." }, "minRooms": { "title": "Minimum rooms / bedrooms", "type": "integer", "description": "Ignore listings with fewer rooms (or bedrooms on Rightmove)." }, "onlyPrivate": { "title": "Private sellers only", "type": "boolean", "description": "When enabled, skip listings marketed by agencies.", "default": false }, "webhookUrl": { "title": "Webhook for alerts (optional)", "type": "string", "description": "New listings are sent as a JSON POST to this address." }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Separate histories when watching several searches in parallel.", "default": "default" }, "emitAllOnFirstRun": { "title": "Return everything on the first run", "type": "boolean", "description": "On a fresh monitor name, return the current stock so the dataset is not empty. Turn off if you only want later deltas.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Portals block data-centre IPs. Default: Apify residential proxies from the matching country.", "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 } } } } } } } } } }