{ "openapi": "3.0.1", "info": { "title": "28Hse Scraper | Hong Kong Real Estate", "description": "Extract structured Hong Kong real estate property listings from 28Hse with prices, estate names, districts, bedroom counts, saleable area, and enriched listing details. Built for enterprise-grade Hong Kong real estate intelligence, pricing analysis, and automated property data pipelines.", "version": "0.0", "x-build-id": "edEULX6izycEwm2ta" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~28hse-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-28hse-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/fatihtahta~28hse-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-28hse-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/fatihtahta~28hse-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-28hse-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": { "enrich_data": { "title": "📄 Enrich results with product page data", "type": "boolean", "description": "Turn this on to visit each product detail page and collect additional data from. Leave it off for a faster run.", "default": false }, "listingMode": { "title": "Listing mode", "enum": [ "buy", "rent" ], "type": "string", "description": "Choose whether query-based requests should search properties for sale or for rent.", "default": "buy" }, "queries": { "title": "Search queries", "type": "array", "description": "Optional free-text queries. Each query is converted into a 28Hse search request with the filters below.", "items": { "type": "string" } }, "propertyType": { "title": "Type", "enum": [ "apartment", "carpark", "office", "shop", "land", "oversea" ], "type": "string", "description": "Optional property type filter applied to query seeds." }, "location": { "title": "Location", "enum": [ "hk_only", "hong_kong_island", "kowloon", "new_territories", "outlying_islands", "oversea" ], "type": "string", "description": "Optional location filter applied to query seeds." }, "minPrice": { "title": "Min price (HKD)", "minimum": 0, "type": "integer", "description": "Optional minimum price in HKD. Leave empty for no lower bound." }, "maxPrice": { "title": "Max price (HKD)", "minimum": 0, "type": "integer", "description": "Optional maximum price in HKD. Leave empty for no upper bound." }, "minSaleableArea": { "title": "Min saleable area (sq ft)", "minimum": 0, "type": "integer", "description": "Optional minimum saleable area in square feet." }, "maxSaleableArea": { "title": "Max saleable area (sq ft)", "minimum": 0, "type": "integer", "description": "Optional maximum saleable area in square feet." }, "bedrooms": { "title": "Bedrooms", "uniqueItems": true, "type": "array", "description": "Optional bedroom filter for query seeds. Multiple selections are allowed.", "items": { "type": "string", "enum": [ "studio", "1", "2", "3", "4", "5+" ], "enumTitles": [ "Studio", "1", "2", "3", "4", "5+" ] } }, "limit": { "title": "Maximum items per seed ", "minimum": 1, "type": "integer", "description": "Optional maximum number of records to save for each URL or query seed. Leave empty to collect all available listings." }, "startUrls": { "title": "Scrape by Direct URL (Listing pages)", "type": "array", "description": "Direct Listing URLs to crawl.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Connection Settings ⚙️", "type": "object", "description": "Optional Apify or custom proxy configuration.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }