{ "openapi": "3.0.1", "info": { "title": "Hipflat Scraper | Thailand Real Estate", "description": "Extract Hipflat property listings across Thailand with rich listing detail, publisher data, pricing, amenities, media and flexible market filters. Built for enterprise-grade Thailand real estate intelligence, lead enrichment, inventory monitoring, and automated analytics pipelines.", "version": "0.0", "x-build-id": "JziYscRhFGA8JP6OF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~hipflat-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-hipflat-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~hipflat-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-hipflat-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~hipflat-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-hipflat-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": { "deal_type": { "title": "Choose Sale or Rent Listings", "enum": [ "buy", "rent" ], "type": "string", "description": "Select the commercial intent for the search. Use sale listings for acquisition research and rent listings for leasing or rental market analysis.", "default": "buy" }, "location": { "title": "Enter Search Location", "type": "string", "description": "Provide a city, district, neighborhood, province, project area, or other Hipflat-supported location. Leave empty when you want a broad Hipflat search without a location boundary." }, "property_type": { "title": "Choose Property Types", "uniqueItems": true, "type": "array", "description": "Select one or more property categories to include. Leave empty to keep the search broad across all supported Hipflat property types.", "items": { "type": "string", "enum": [ "condo", "house", "townhouse", "apartment", "land", "office", "hotel", "commercial", "industrial_unit", "serviced_apartment", "villa" ], "enumTitles": [ "Condo", "House", "Townhouse", "Apartment", "Land", "Office", "Hotel", "Commercial / retail space", "Industrial unit / warehouse", "Serviced apartment", "Villa" ] } }, "currency": { "title": "Choose Price Currency", "enum": [ "EUR", "THB", "USD", "AED", "ARS", "AUD", "BRL", "CAD", "CHF", "CLP", "CLF", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "GBP", "HKD", "HUF", "IDR", "INR", "JPY", "KES", "KWD", "LBP", "MAD", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PAB", "PEN", "PHP", "PKR", "PLN", "QAR", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "TWD", "UAH", "UYU", "VES", "VND", "ZAR" ], "type": "string", "description": "Select a currency for displayed listing prices. Leave empty to use Hipflat's default price presentation for the selected market." }, "min_price": { "title": "Set Minimum Price", "minimum": 0, "type": "integer", "description": "Only include listings priced at or above this amount in the selected currency. Leave empty when there is no lower price boundary." }, "max_price": { "title": "Set Maximum Price", "minimum": 0, "type": "integer", "description": "Only include listings priced at or below this amount in the selected currency. Leave empty when there is no upper price boundary." }, "bedroom_count": { "title": "Choose Bedroom Counts", "uniqueItems": true, "type": "array", "description": "Select one or more bedroom counts to include. Studio represents 0 bedrooms, and 4 or more includes listings at the upper bedroom range.", "items": { "type": "string", "enum": [ "0", "1", "2", "3", "4" ], "enumTitles": [ "Studio", "1 bedroom", "2 bedrooms", "3 bedrooms", "4+ bedrooms" ] } }, "bathroom_count": { "title": "Choose Bathroom Counts", "uniqueItems": true, "type": "array", "description": "Select one or more bathroom counts to include. The 5 or more option includes listings at the upper bathroom range.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 bathroom", "2 bathrooms", "3 bathrooms", "4 bathrooms", "5+ bathrooms" ] } }, "min_usable_area": { "title": "Set Minimum Usable Area", "minimum": 0, "type": "integer", "description": "Only include listings with usable area at or above this many square meters. Leave empty when there is no lower size boundary." }, "max_usable_area": { "title": "Set Maximum Usable Area", "minimum": 0, "type": "integer", "description": "Only include listings with usable area at or below this many square meters. Leave empty when there is no upper size boundary." }, "amenities": { "title": "Choose Required Amenities", "uniqueItems": true, "type": "array", "description": "Select one or more amenities to narrow results to listings with those features. Leave empty when amenities should not restrict the search.", "items": { "type": "string", "enum": [ "cellar", "cleaning_room", "equipped_bathroom", "equipped_kitchen", "integral_kitchen", "office", "service_room", "storage_room", "children_s_area", "gym", "jacuzzi", "multiuse_room", "roof_garden", "sauna", "swimming_pool", "tennis_court", "built_in_wardrobe", "disabled_access", "library", "lift", "panoramic_view", "balcony", "garden", "green_area", "grill", "terrace", "yard", "alarm", "guardhouse", "security", "security_door", "concierge", "air_conditioning", "car_park", "electricity", "fireplace", "heating", "internet", "natural_gas", "video_cable", "water", "water_tank" ], "enumTitles": [ "Cellar", "Laundry room", "Equipped bathroom", "Equipped kitchen", "Integral kitchen", "Office room", "Service room", "Storage room", "Children area", "Gym", "Jacuzzi", "Multipurpose room", "Roof garden", "Sauna", "Swimming pool", "Tennis court", "Built-in wardrobe", "Access for people with disabilities", "Library", "Lift", "Panoramic view", "Balcony", "Garden", "Green area", "Grill", "Terrace", "Yard", "Alarm", "Guardhouse", "Security", "Security door", "Concierge", "Air conditioning", "Parking", "Electricity", "Fireplace", "Heating", "Internet", "Natural gas", "Video cable", "Water", "Water tank" ] } }, "publication_date": { "title": "Choose Listing Freshness", "enum": [ "24-hours", "7-days", "30-days" ], "type": "string", "description": "Select a recent publication window to focus on newer listings. Leave empty to include listings regardless of publication date." }, "sort_by": { "title": "Choose Result Order", "enum": [ "relevance", "price_asc", "price_desc", "bedrooms_asc", "bedrooms_desc", "usable_floor_area_asc", "usable_floor_area_desc", "first_publish_date_desc" ], "type": "string", "description": "Select how matching listings should be ordered before collection. Leave empty to use Hipflat's standard relevance-based ordering." }, "maximize_coverage": { "title": "Collect More Matching Listings", "type": "boolean", "description": "Keep this enabled for large searches that may exceed the visible-result limit. Turn it off for faster exploratory runs where the first visible set of matching listings is enough.", "default": true }, "enrich_data": { "title": "Collect Richer Property Listing Details", "type": "boolean", "description": "Enable this for more complete property listings. This may make the run slower because the actor may spend more time collecting details for each result. Turn it off for faster runs when the standard result fields are enough.", "default": true }, "limit": { "title": "Set Maximum Results", "minimum": 1, "type": "integer", "description": "Enter the maximum number of listings to save. Leave empty to continue collecting available matches until the run naturally finishes." } } }, "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 } } } } } } } } } }