{ "openapi": "3.0.1", "info": { "title": "Global Property Search", "description": "The most comprehensive real estate search Actor on Apify. Search property listings in **30+ countries** from **20+ major websites** with a single API call.", "version": "1.0", "x-build-id": "FwrLdt3bZlSQL5X74" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wonderful_beluga~global-property-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wonderful_beluga-global-property-search", "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/wonderful_beluga~global-property-search/runs": { "post": { "operationId": "runs-sync-wonderful_beluga-global-property-search", "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/wonderful_beluga~global-property-search/run-sync": { "post": { "operationId": "run-sync-wonderful_beluga-global-property-search", "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": [ "country", "city", "category" ], "properties": { "country": { "title": "Country", "enum": [ "us", "uk", "ca", "au", "de", "fr", "es", "it", "pt", "nl", "be", "at", "ch", "ie", "se", "no", "dk", "fi", "pl", "cz", "gr", "tr", "ae", "eg", "sa", "in", "sg", "jp", "br", "mx", "za", "nz", "th" ], "type": "string", "description": "Select the country to search properties in", "default": "us" }, "city": { "title": "City", "type": "string", "description": "Enter the city or area to search (e.g., 'New York', 'London', 'Berlin', 'Madrid', 'Dubai', 'Sydney')", "default": "New York" }, "targetSite": { "title": "Target Website", "enum": [ "auto", "zillow", "realtor", "redfin", "rightmove", "zoopla", "realtor_ca", "realestate_au", "domain_au", "immobilienscout24", "immowelt", "seloger", "leboncoin", "idealista", "funda", "propertyfinder_ae", "bayut", "magicbricks", "trademe_nz", "property24", "sahibinden" ], "type": "string", "description": "Select which site to scrape. 'Auto' picks the best site for your country.", "default": "auto" }, "category": { "title": "Category", "enum": [ "sale", "rent" ], "type": "string", "description": "Select whether to search for properties for sale or rent", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "all", "house", "apartment", "condo", "townhouse", "land" ], "type": "string", "description": "Filter by property type", "default": "all" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum price in local currency (leave empty for no minimum)" }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum price in local currency (leave empty for no maximum)" }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms", "default": 0 }, "maxBedrooms": { "title": "Maximum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms (leave empty for no maximum)" }, "maxItems": { "title": "Maximum Items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of listings to scrape (higher values = longer runtime)", "default": 100 }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of result pages to scrape per site", "default": 3 }, "onlyNewListings": { "title": "Only New Listings", "type": "boolean", "description": "When enabled, only report listings that weren't seen in previous runs. Perfect for scheduled monitoring.", "default": true }, "slackWebhookUrl": { "title": "Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL to receive new listing notifications. Get yours at https://api.slack.com/messaging/webhooks" }, "discordWebhookUrl": { "title": "Discord Webhook URL", "type": "string", "description": "Discord webhook URL to receive new listing notifications. Create one in your Discord server settings." }, "emailWebhookUrl": { "title": "Email Webhook URL", "type": "string", "description": "Email service webhook URL (e.g., Zapier, Make.com, SendGrid) for email notifications" }, "recipientEmail": { "title": "Recipient Email", "type": "string", "description": "Email address to receive notifications (required if using Email Webhook)" }, "debug": { "title": "Debug Mode", "type": "boolean", "description": "Enable verbose logging for troubleshooting", "default": 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 } } }, "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 } } } } } } } } } }