{ "openapi": "3.0.1", "info": { "title": "PropertyGuru Scraper | Singapore Malaysia Real Estate API", "description": "Scrape PropertyGuru Singapore & Malaysia plus CommercialGuru — HDB, condo, landed, rooms, office & retail for sale or rent. Prices, agents & images — PropertyGuru API alternative.", "version": "0.5", "x-build-id": "bPXGD5LP31RzJKIZk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~propertyguru-sg-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-propertyguru-sg-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/lentic_clockss~propertyguru-sg-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-propertyguru-sg-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/lentic_clockss~propertyguru-sg-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-propertyguru-sg-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "PropertyGuru SG/MY or CommercialGuru search/listing URLs. Overrides market-built searches when provided.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "market": { "title": "Market", "enum": [ "SG", "MY", "CG", "all" ], "type": "string", "description": "Primary market: SG (Singapore), MY (Malaysia), CG (CommercialGuru SG), or all.", "default": "SG" }, "markets": { "title": "Markets (multi)", "type": "array", "description": "Optional multi-select. When set, overrides single market (except startUrls).", "items": { "type": "string", "enum": [ "SG", "MY", "CG", "all" ] } }, "location": { "title": "Location", "type": "string", "description": "Area / city hint when building search URLs (e.g. singapore, orchard, kuala-lumpur, penang). Empty uses market default." }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT" ], "type": "string", "description": "BUY (for sale) or RENT (for rent).", "default": "BUY" }, "propertyType": { "title": "Property type (single)", "enum": [ "all", "residential", "commercial", "hdb", "condo", "apartment", "landed", "landed-house", "terraced-house", "terrace-house", "semi-detached-house", "bungalow", "executive-condo", "good-class-bungalow", "cluster-house", "townhouse", "room", "office", "retail", "industrial", "warehouse", "land" ], "type": "string", "description": "Single category or bundle. Ignored when propertyTypes is non-empty. Use all for market primary nav categories.", "default": "all" }, "propertyTypes": { "title": "Property types (multi)", "type": "array", "description": "Multi-select categories / bundles. Takes precedence over propertyType when non-empty.", "items": { "type": "string", "enum": [ "all", "residential", "commercial", "hdb", "condo", "apartment", "landed", "landed-house", "terraced-house", "terrace-house", "semi-detached-house", "bungalow", "executive-condo", "good-class-bungalow", "cluster-house", "townhouse", "room", "office", "retail", "industrial", "warehouse", "land" ] } }, "districtCode": { "title": "District code", "type": "string", "description": "Optional district filter appended as district_code query param (e.g. D09)." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Optional minimum price filter (minprice query param)." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Optional maximum price filter (maxprice query param). Must be >= minPrice when both set." }, "bedrooms": { "title": "Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional bedroom count filter (beds query param)." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum listing records to emit (fair-shared across markets/categories).", "default": 20 }, "maxPages": { "title": "Max SRP pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum search-result pages to crawl per start URL.", "default": 1 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "When true, open each listing LDP and merge overview/location fields from __NEXT_DATA__.", "default": true }, "requestDelayMillis": { "title": "Request delay (ms)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Delay before each navigation to reduce challenge rate.", "default": 2000 } } }, "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 } } } } } } } } } }