{ "openapi": "3.0.1", "info": { "title": "Savills Property Scraper", "description": "An Apify Actor that scrapes property listings from Savills real estate listings, extracting detailed information about properties for sale, rent, or recently sold.", "version": "0.0", "x-build-id": "BsntLfU5E3VKyGyxO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nocodeventure~savills-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nocodeventure-savills-property-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/nocodeventure~savills-property-scraper/runs": { "post": { "operationId": "runs-sync-nocodeventure-savills-property-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/nocodeventure~savills-property-scraper/run-sync": { "post": { "operationId": "run-sync-nocodeventure-savills-property-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Savills search result URLs to scrape. You can configure a search on savills.com and paste the URL here. Any filters set below will override parameters in the URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingType": { "title": "Listing Type", "enum": [ "", "buy", "rent", "sold" ], "type": "string", "description": "Type of property listings to scrape. Overrides the URL parameter if set." }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum property price. Overrides URL if set. For rentals, this is the price per period." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum property price. Overrides URL if set." }, "currency": { "title": "Currency", "enum": [ "GBP", "USD", "EUR" ], "type": "string", "description": "Currency for price display.", "default": "GBP" }, "rentalPeriod": { "title": "Rental Period", "enum": [ "Week", "Month" ], "type": "string", "description": "Price period for rental properties.", "default": "Week" }, "bedrooms": { "title": "Bedrooms", "enum": [ "", "-1", "GRS_B_1", "GRS_B_2", "GRS_B_3", "GRS_B_4", "GRS_B_5", "GRS_B_6" ], "type": "string", "description": "Number of bedrooms filter. Overrides URL if not set to 'Use URL Setting'." }, "bathrooms": { "title": "Bathrooms", "enum": [ "", "-1", "GRS_BT_1", "GRS_BT_2", "GRS_BT_3", "GRS_BT_4", "GRS_BT_5" ], "type": "string", "description": "Number of bathrooms filter. Overrides URL if not set to 'Use URL Setting'." }, "receptions": { "title": "Reception Rooms", "enum": [ "", "-1", "GRS_REC_1", "GRS_REC_2", "GRS_REC_3", "GRS_REC_4", "GRS_REC_5" ], "type": "string", "description": "Number of reception rooms filter. Overrides URL if not set to 'Use URL Setting'." }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "Types of properties to include. Overrides URL if any selected.", "items": { "type": "string", "enum": [ "GRS_PT_ND", "GRS_PT_DH", "GRS_PT_SDH", "GRS_PT_TH", "GRS_PT_F", "GRS_PT_BU", "GRS_PT_CT", "GRS_PT_L" ], "enumTitles": [ "New Development", "Detached House", "Semi-Detached House", "Terraced House", "Flat/Apartment", "Bungalow", "Cottage", "Land" ] } }, "minSize": { "title": "Minimum Size", "minimum": 0, "type": "integer", "description": "Minimum property size. Overrides URL if set." }, "maxSize": { "title": "Maximum Size", "minimum": 0, "type": "integer", "description": "Maximum property size. Overrides URL if set." }, "sizeUnit": { "title": "Size Unit", "enum": [ "SquareFeet", "SquareMeter" ], "type": "string", "description": "Unit for property size measurements.", "default": "SquareFeet" }, "features": { "title": "Property Features", "type": "array", "description": "Filter by specific property features. Overrides URL if any selected.", "items": { "type": "string", "enum": [ "GRS_FTR_PRD", "GRS_FTR_LL", "GRS_FTR_B", "GRS_FTR_CON", "GRS_FTR_GAR", "GRS_FTR_GDN", "GRS_FTR_G", "GRS_FTR_L", "GRS_FTR_OSP", "GRS_FTR_RT", "GRS_FTR_TC", "GRS_FTR_SP" ], "enumTitles": [ "Period Property", "Listed Building", "Balcony", "Concierge", "Garage", "Garden", "Gym", "Lift", "Off-Street Parking", "Roof Terrace", "Tennis Court", "Swimming Pool" ] } }, "furnishing": { "title": "Furnishing (Rentals)", "type": "array", "description": "Furnishing options for rental properties. Overrides URL if any selected.", "items": { "type": "string", "enum": [ "GRS_FU_UF", "GRS_FU_PF", "GRS_FU_F", "GRS_FU_BF" ], "enumTitles": [ "Unfurnished", "Part Furnished", "Furnished", "Bills Included" ] } }, "leaseType": { "title": "Lease Type (Rentals)", "type": "array", "description": "Lease type options for rental properties. Overrides URL if any selected.", "items": { "type": "string", "enum": [ "GRS_LT_LT", "GRS_LT_ST" ], "enumTitles": [ "Long Term", "Short Term" ] } }, "lifestyles": { "title": "Lifestyle Preferences", "type": "array", "description": "Lifestyle-related property filters. Overrides URL if any selected.", "items": { "type": "string", "enum": [ "GRS_LS_WS", "GRS_LS_PF" ], "enumTitles": [ "Waterside", "Pet Friendly" ] } }, "sortOrder": { "title": "Sort Order", "enum": [ "", "SO_PCDD", "SO_PCDA", "SO_DD", "SO_DA" ], "type": "string", "description": "How to sort the search results. Overrides URL if not set to 'Use URL Setting'." }, "maxConcurrency": { "title": "Concurrent Browsers", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of browser instances to run in parallel. Higher values speed up scraping but use more memory.", "default": 1 }, "maxRequestsPerCrawl": { "title": "Max Requests per Crawl", "minimum": 0, "type": "integer", "description": "Maximum number of HTTP requests (0 = unlimited).", "default": 100 }, "maxPages": { "title": "Max Listing Pages", "minimum": 0, "type": "integer", "description": "Maximum number of listing pages to process (0 = unlimited).", "default": 0 }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Maximum number of individual properties to scrape (0 = unlimited). This takes precedence over Max Listing Pages.", "default": 2 }, "scrapeDetails": { "title": "Scrape Property Details", "type": "boolean", "description": "Whether to visit each property page for full details. Disabling this will only scrape basic info from listing pages.", "default": true }, "maxImages": { "title": "Max Images per Property", "minimum": -1, "type": "integer", "description": "Maximum number of images to extract per property. Set to 0 for unlimited images. Set to -1 to skip image extraction entirely (faster scraping).", "default": 1 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for anti-bot protection.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }