{ "openapi": "3.0.1", "info": { "title": "All Property Scraper", "description": "Unified real estate data API for Zillow, Rightmove, Domain, Redfin, Realtor.com, MagicBricks, and more. Collect sale, rental, and sold listings with country-aware routing, rich property details, prices, images, agents, geo data, and source URLs.", "version": "1.0", "x-build-id": "H2oLEYRfkB4Lc5hGW" }, "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" ], "properties": { "max_results": { "title": "๐Ÿ“Š Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of property listings to return" }, "country": { "title": "๐ŸŒ Country", "enum": [ "Andorra", "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 where the target property listings are located" }, "location": { "title": "๐Ÿ“ Location", "type": "string", "description": "City, region, neighborhood, postal code, or address supported by the selected platform" }, "listing_type": { "title": "๐Ÿ  Listing Type", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Choose the transaction status to search" }, "property_type": { "title": "๐Ÿ˜๏ธ Property Type", "enum": [ "residential", "house", "apartment", "condo", "townhouse", "land", "commercial", "new_development", "room", "student_housing", "senior_housing", "auction", "ready_to_build", "other" ], "type": "string", "description": "Optional property or asset type filter. Leave empty to include all supported property types" }, "platforms": { "title": "๐Ÿข Platforms", "type": "array", "description": "Optional platform selection. Leave empty to search all supported platforms for the selected country", "items": { "type": "string", "enum": [ "Zillow", "Craigslist Housing", "Leboncoin Immobilier", "Realtor.com", "Redfin", "Trulia", "Movoto", "RentCafe", "Rightmove", "Apartments.com", "Homes.com", "Domain", "Realtor.ca", "Immowelt", "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", "ImmobilienScout24", "LoopNet", "Trade Me Property", "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 } } } } } } } } } }