{ "openapi": "3.0.1", "info": { "title": "Egypt Real Estate Aggregator", "version": "5.0", "x-build-id": "hQltHYQGXfTxm2w5T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wonderful_beluga~egypt-real-estate-aggregator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wonderful_beluga-egypt-real-estate-aggregator", "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~egypt-real-estate-aggregator/runs": { "post": { "operationId": "runs-sync-wonderful_beluga-egypt-real-estate-aggregator", "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~egypt-real-estate-aggregator/run-sync": { "post": { "operationId": "run-sync-wonderful_beluga-egypt-real-estate-aggregator", "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": [ "maxResults" ], "properties": { "searchQuery": { "title": "Search Keywords (Optional)", "type": "string", "description": "Leave blank or type 'all' to crawl all Egyptian real estate nationwide, or filter by keywords like 'New Cairo', 'Marassi', 'Villa'", "default": "" }, "targetPortals": { "title": "Target Real Estate Portals", "type": "array", "description": "Select real estate platforms to aggregate listings from", "items": { "type": "string", "enum": [ "propertyfinder", "aqarmap", "dubizzle", "nawy" ], "enumTitles": [ "PropertyFinder Egypt (propertyfinder.eg)", "Aqarmap Egypt (aqarmap.com.eg)", "Dubizzle Egypt / OLX (dubizzle.com.eg)", "Nawy Compound Launches (nawy.com)" ] }, "default": [ "propertyfinder", "aqarmap", "dubizzle", "nawy" ] }, "crawlAllRegions": { "title": "Crawl All Egyptian Governorates Nationwide", "type": "boolean", "description": "Automatically generates search queues across New Cairo, October, Zayed, New Capital, Sahel, Alex, Red Sea, Sokhna & Delta", "default": true }, "deepPagesLimit": { "title": "Max Pages per Region / Portal", "minimum": 1, "maximum": 50, "type": "integer", "description": "Number of deep pagination pages to crawl per portal region (1 to 50 pages)", "default": 10 }, "listingType": { "title": "Listing Type", "enum": [ "buy", "rent", "both" ], "type": "string", "description": "Filter by Buy (Sale), Rent, or Both", "default": "buy" }, "propertyType": { "title": "Property Category", "enum": [ "all", "apartment", "villa", "townhouse", "duplex", "chalet", "commercial" ], "type": "string", "description": "Filter by property structure", "default": "all" }, "minPrice": { "title": "Minimum Price (EGP)", "type": "integer", "description": "Filter listings starting from this total price in EGP", "default": 0 }, "maxPrice": { "title": "Maximum Price (EGP)", "type": "integer", "description": "Filter listings up to this total price in EGP (0 for no max)", "default": 0 }, "maxResults": { "title": "Maximum Properties to Extract", "minimum": 10, "maximum": 50000, "type": "integer", "description": "Maximum total property listings to extract per run (up to 50,000)", "default": 1000 }, "minRoiScore": { "title": "Minimum ROI Deal Score (0–100)", "minimum": 0, "maximum": 90, "type": "integer", "description": "Filter out lower-tier listings and only include high-investment value deals", "default": 0 } } }, "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 } } } } } } } } } }