{ "openapi": "3.0.1", "info": { "title": "PropertyGuru Singapore Scraper", "description": "Scrape sale and rental listings from propertyguru.com.sg — price, size, bedrooms, location, agent contact, photos, MRT distances, and more. Returns clean structured JSON / CSV / Excel.", "version": "0.1", "x-build-id": "uVpXY2ufQfoCaOD6o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alwaysprimedev~propertyguru-singapore-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alwaysprimedev-propertyguru-singapore-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/alwaysprimedev~propertyguru-singapore-scraper/runs": { "post": { "operationId": "runs-sync-alwaysprimedev-propertyguru-singapore-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/alwaysprimedev~propertyguru-singapore-scraper/run-sync": { "post": { "operationId": "run-sync-alwaysprimedev-propertyguru-singapore-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": { "searchType": { "title": "Search type", "enum": [ "sale", "rent" ], "type": "string", "description": "Whether to scrape properties for sale or for rent on propertyguru.com.sg.", "default": "sale" }, "freetext": { "title": "Search keywords", "type": "string", "description": "Free-text query — e.g. a project name (\"The Sail\"), a street (\"Orchard Road\"), or an area. Leave empty to scrape all listings of the chosen type." }, "districts": { "title": "Districts", "uniqueItems": true, "type": "array", "description": "Singapore postal district codes (D01–D28) to restrict results to. Leave empty for the entire island. Each district matches the official URA mapping.", "items": { "type": "string" } }, "propertyTypeCodes": { "title": "Property type codes", "uniqueItems": true, "type": "array", "description": "Restrict results to specific property types. Common codes: APT (Apartment), CONDO (Condominium), HDB, EXEC (Executive Condo), SEMI (Semi-Detached), TERR (Terraced House), BUNG (Bungalow), LAND (Landed). Omit to allow all types.", "items": { "type": "string" } }, "minPrice": { "title": "Min price (SGD)", "minimum": 0, "type": "integer", "description": "Lower bound on the listing price in Singapore dollars. For rental listings this is the monthly rent." }, "maxPrice": { "title": "Max price (SGD)", "minimum": 0, "type": "integer", "description": "Upper bound on the listing price in Singapore dollars. For rental listings this is the monthly rent." }, "bedrooms": { "title": "Bedroom counts", "uniqueItems": true, "type": "array", "description": "Filter to listings with these exact bedroom counts. Use 0 for studios. Leave empty for any.", "items": { "type": "string" } }, "sortBy": { "title": "Sort order", "enum": [ "default", "price_low", "price_high" ], "type": "string", "description": "How to sort the search results. \"Default\" uses PropertyGuru's relevance ranking. Date-based sorting is intentionally not exposed — use \"Only listings posted after\" below for incremental runs instead.", "default": "default" }, "since": { "title": "Only listings posted after", "type": "string", "description": "ISO-8601 timestamp (e.g. 2026-05-01T00:00:00Z). Listings posted before this moment are skipped — useful for daily incremental refresh runs without re-paying for already-seen data." }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "When enabled (default) every listing's full detail page is fetched — agent contact, photos, MRT distances, descriptions, all flat-record fields. Disable for an index-only run that returns just IDs + URLs at ~10× lower cost; useful for diff-only daily refreshes.", "default": true }, "maxItems": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Cap on the number of listings to scrape. Set to 0 for unlimited (scrape every matching listing across all pages). Caps both pagination and detail fetches — the actor stops fetching search pages as soon as enough URLs are queued.", "default": 50 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many detail pages to fetch in parallel. Higher = faster but more aggressive on the source site. The default of 3 is polite and works without proxies. Raise carefully — values above 5 risk triggering Cloudflare rate-limits.", "default": 3 }, "startUrls": { "title": "Custom start URLs (advanced)", "uniqueItems": true, "type": "array", "description": "Power-user override: drop in already-built PropertyGuru search URLs (e.g. complex filtered pages, agent-listing pages, project pages) and the actor will paginate from page 1 of each. Overrides all simple filters above when provided.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } } } }, "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 } } } } } } } } } }