{ "openapi": "3.0.1", "info": { "title": "All Property Scraper (40 Sites)", "description": "Search Zillow, Realtor.com, Redfin, Rightmove, Zoopla, MagicBricks, NoBroker, Property24, and more from one AgentX actor. Export prices, addresses, images, contacts, geo data, listing details, and source URLs for real estate market research and lead generation.", "version": "1.0", "x-build-id": "ptZqmfQH7ahiZ2HAm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agentx~all-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agentx-all-property-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/agentx~all-property-scraper/runs": { "post": { "operationId": "runs-sync-agentx-all-property-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/agentx~all-property-scraper/run-sync": { "post": { "operationId": "run-sync-agentx-all-property-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", "required": [ "max_results", "country", "location", "listing_type" ], "properties": { "max_results": { "title": "๐Ÿ“Š Max Results", "minimum": 1, "type": "integer", "description": "Maximum number of property listings to return per selected platform" }, "country": { "title": "๐ŸŒ Country", "enum": [ "Australia", "Botswana", "Brazil", "Canada", "France", "Germany", "India", "Italy", "Japan", "Kenya", "Mauritius", "Mozambique", "Namibia", "Netherlands", "New Zealand", "Nigeria", "Poland", "South Africa", "Spain", "Sweden", "United Kingdom", "United States", "Zambia", "Zimbabwe" ], "type": "string", "description": "Country selector with 24 supported markets. Country routing uses only marketplaces mapped to the requested market." }, "location": { "title": "๐Ÿ“ Location", "type": "string", "description": "City, region, neighborhood, postal code, or address to search across 39 supported property marketplaces" }, "listing_type": { "title": "๐Ÿ  Listing Type", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Transaction type. The multi-source route supports for_sale, for_rent, and sold where the selected marketplace supports them." }, "property_type": { "title": "๐Ÿ˜๏ธ Property Type", "enum": [ "residential", "house", "apartment", "condo", "townhouse", "land", "commercial", "new_development", "room", "auction", "ready_to_build" ], "type": "string", "description": "Optional property-type filter with 11 normalized values and source-specific support. Leave empty for no property-type restriction." }, "posted_since": { "title": "๐Ÿ“… Posted Since", "type": "string", "description": "Optional listing-age filter; it applies only to routes that expose a posted-date filter. Leave empty to avoid date filtering." }, "platforms": { "title": "๐Ÿงญ Platforms", "type": "array", "description": "Optional marketplaces to search from 39 supported sources. Leave empty to use every supported marketplace mapped to the selected country.", "items": { "type": "string", "enum": [ "Zillow", "Craigslist Housing", "Leboncoin Immobilier", "Realtor.com", "Redfin", "Trulia", "LoopNet", "Movoto", "RentCafe", "Rightmove", "Homes.com", "Domain", "Realtor.ca", "Immowelt", "Trade Me Property", "ImmobilienScout24", "Immobiliare.it", "Zoopla", "ZAP Imรณveis", "Fotocasa", "Hemnet", "Apartment List", "AtHome Japan", "Casa.it", "Centris", "Chaves na Mรฃo", "Funda", "Homes/LIFULL", "MagicBricks", "NoBroker", "99acres", "OnTheMarket", "Otodom", "Property24", "QuintoAndar", "Rent.com", "SUUMO", "VivaReal", "Vrbo" ] } } } }, "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 } } } } } } } } } }