{ "openapi": "3.0.1", "info": { "title": "LuxuryEstate Scraper — Luxury Homes for Sale & Rent", "description": "Scrape LuxuryEstate.com luxury property listings in 100+ countries by country, region or city: price, bedrooms, bathrooms, size, location and coordinates, photos, agency and listing tier. Optional full description, all photos, floor plans, energy class and the agency's business contacts. No login.", "version": "0.1", "x-build-id": "78bfvoupz4i2C5i53" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~luxuryestate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-luxuryestate-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/yugenox~luxuryestate-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-luxuryestate-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/yugenox~luxuryestate-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-luxuryestate-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": { "locations": { "title": "📍 Locations", "type": "array", "description": "Countries, regions, provinces or cities, e.g. \"Tuscany\", \"Marbella\", \"Miami\", \"Côte d'Azur\", \"France\", \"London, England\". Add the region or country after a comma when a name exists in several places (\"Paris, France\"). Each place is searched separately.", "items": { "type": "string" } }, "transaction": { "title": "For sale or for rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Search listings for sale or for rent.", "default": "sale" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Empty = every type. Each type is searched separately.", "items": { "type": "string", "enum": [ "villas", "apartments", "houses", "penthouses", "country-houses", "castles", "mansions", "chalet-cottages", "townhouses", "lofts", "islands", "lands", "hotels", "residential-complex", "offices" ], "enumTitles": [ "Villas", "Apartments", "Houses", "Penthouses", "Country houses", "Castles", "Mansions", "Chalets & cottages", "Townhouses", "Lofts", "Islands", "Land", "Hotels", "Residential complexes", "Offices" ] } }, "maxItems": { "title": "Max listings", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of listings for the whole run, shared fairly between your searches (a search that finds fewer leaves its share to the others). 0 = everything.", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Also open every property page for the full description, all photos, floor plans, energy class, view, parking, the street address when the agency publishes it, and the agency's business phone, e-mail and office address.", "default": false }, "startUrls": { "title": "🔗 LuxuryEstate URLs", "type": "array", "description": "Optional: LuxuryEstate search pages (filters in the URL are kept), e.g. https://www.luxuryestate.com/villas-italy/tuscany, or property pages, e.g. https://www.luxuryestate.com/p132782927-apartment-for-sale-cagnes-sur-mer.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "In the currency below. Listings with the price on request are left out when a price filter is set." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "In the currency below." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Only listings with at least this many bedrooms. Leave empty for no limit." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Only listings with at least this many bathrooms. Leave empty for no limit." }, "minLivingArea": { "title": "Min living area (m²)", "minimum": 0, "type": "integer", "description": "Only listings whose living area (m²) is at least this value. Leave empty for no limit." }, "maxLivingArea": { "title": "Max living area (m²)", "minimum": 0, "type": "integer", "description": "Only listings whose living area (m²) is at most this value. Leave empty for no limit." }, "currency": { "title": "Currency", "enum": [ "EUR", "USD", "GBP", "CHF" ], "type": "string", "description": "Currency for prices and price filters. LuxuryEstate converts every listing's price into it.", "default": "EUR" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If LuxuryEstate refuses datacenter IPs for a while, the run switches to residential proxies when your account has them.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }