{ "openapi": "3.0.1", "info": { "title": "Supercasa Scraper - Portugal Real Estate", "description": "Scrape SuperCasa Portugal real estate listings for sale or rent. Collect property data by city, category, price, area, and features. Export clean datasets for market research, lead generation, and monitoring Portuguese property trends. Best supercasa.com data extractor.", "version": "0.0", "x-build-id": "SOrIv283pwZ2coB0d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igolaizola~supercasa-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igolaizola-supercasa-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/igolaizola~supercasa-scraper/runs": { "post": { "operationId": "runs-sync-igolaizola-supercasa-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/igolaizola~supercasa-scraper/run-sync": { "post": { "operationId": "run-sync-igolaizola-supercasa-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": [ "maxItems", "location" ], "properties": { "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of listings to scrape.", "default": 100 }, "location": { "title": "Location", "type": "string", "description": "City/area name to search (e.g. Lisbon, Porto)." }, "operation": { "title": "Operation", "enum": [ "buy", "rent" ], "type": "string", "description": "Search operation: buy or rent.", "default": "buy" }, "propertyTypes": { "title": "Property Type", "type": "array", "description": "Choose one or more property types from the app.", "items": { "type": "string", "enum": [ "new-homes", "homes", "offices", "commercial", "garages", "land", "storage", "buildings", "rooms" ], "enumTitles": [ "New homes & developments", "Homes & flats", "Offices", "Commercial properties", "Garages", "Land plots", "Storage rooms", "Buildings", "Rooms" ] } }, "propertySubtypes": { "title": "Property Subtypes", "type": "array", "description": "Optional subtypes (only apply to some property types).", "items": { "type": "string", "enum": [ "houses", "flats-apartments", "country-homes", "duplex", "penthouses", "offices", "commercial-premises", "industrial-warehouse", "hospitality", "garages", "land", "storage-rooms", "buildings", "rooms" ], "enumTitles": [ "Houses", "Flats / Apartments", "Country homes", "Duplex", "Penthouses", "Offices", "Commercial premises", "Industrial building / warehouse", "Hospitality", "Garages", "Land", "Storage rooms", "Buildings", "Rooms" ] } }, "sortBy": { "title": "Sort By", "enum": [ "new", "relevance", "lowest-price", "highest-price", "latest", "older", "price-reduction", "lowest-price-m2", "highest-price-m2", "biggest", "smallest", "upper-floors", "lower-floors" ], "type": "string", "description": "Sorting method for results.", "default": "new" }, "priceMin": { "title": "Min Price", "minimum": 0, "type": "integer", "description": "Minimum price.", "default": 0 }, "priceMax": { "title": "Max Price", "minimum": 0, "type": "integer", "description": "Maximum price.", "default": 0 }, "areaMin": { "title": "Min Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum area (m²).", "default": 0 }, "areaMax": { "title": "Max Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum area (m²).", "default": 0 }, "bedrooms": { "title": "Bedrooms", "enum": [ "", "studio", "1", "2", "3", "4+" ], "type": "string", "description": "Minimum number of bedrooms.", "default": "" }, "bathrooms": { "title": "Bathrooms", "enum": [ "", "1", "2", "3+" ], "type": "string", "description": "Minimum number of bathrooms.", "default": "" }, "floorType": { "title": "Floor Type", "enum": [ "", "lower", "middle", "upper" ], "type": "string", "description": "Filter by floor level.", "default": "" }, "status": { "title": "Property Status", "enum": [ "", "new", "used", "construction", "renovation" ], "type": "string", "description": "Filter by property status.", "default": "" }, "yearConstructionMin": { "title": "Min Year of Construction", "minimum": 0, "type": "integer", "description": "Minimum year of construction.", "default": 0 }, "yearConstructionMax": { "title": "Max Year of Construction", "minimum": 0, "type": "integer", "description": "Maximum year of construction.", "default": 0 }, "hasMediaVirtualVisit": { "title": "Has Virtual Visit", "type": "boolean", "description": "Only include listings with virtual visits.", "default": false }, "rentToOwn": { "title": "Rent to Own", "type": "boolean", "description": "Only include rent-to-own listings.", "default": false }, "featureSearchHasAC": { "title": "Has AC", "type": "boolean", "description": "Only include listings with air conditioning.", "default": false }, "featureSearchHasStorage": { "title": "Has Storage", "type": "boolean", "description": "Only include listings with storage.", "default": false }, "featureSearchHasElevator": { "title": "Has Elevator", "type": "boolean", "description": "Only include listings with elevator.", "default": false }, "featureSearchHasGarden": { "title": "Has Garden", "type": "boolean", "description": "Only include listings with garden.", "default": false }, "featureSearchHasGarage": { "title": "Has Garage", "type": "boolean", "description": "Only include listings with garage.", "default": false }, "featureSearchHasPool": { "title": "Has Pool", "type": "boolean", "description": "Only include listings with pool.", "default": false }, "featureSearchHasCloset": { "title": "Has Closet", "type": "boolean", "description": "Only include listings with closet.", "default": false }, "featureSearchHasTerrace": { "title": "Has Terrace", "type": "boolean", "description": "Only include listings with terrace.", "default": false }, "featureSearchHasHeating": { "title": "Has Heating", "type": "boolean", "description": "Only include listings with heating.", "default": false }, "featureSearchHasVigilance": { "title": "Has Vigilance", "type": "boolean", "description": "Only include listings with security/vigilance.", "default": false }, "featureSearchHasAutomaticGate": { "title": "Has Automatic Gate", "type": "boolean", "description": "Only include listings with automatic gate.", "default": false }, "featureSearchHasMotoParking": { "title": "Has Motorcycle Parking", "type": "boolean", "description": "Only include listings with motorcycle parking.", "default": false }, "featureSearchHasCornerLocation": { "title": "Corner Location", "type": "boolean", "description": "Only include listings with corner location.", "default": false }, "featureSearchHasSmokeExtractor": { "title": "Has Smoke Extractor", "type": "boolean", "description": "Only include listings with smoke extractor.", "default": false }, "featureSearchHasHotWater": { "title": "Has Hot Water", "type": "boolean", "description": "Only include listings with hot water.", "default": false }, "featureSearchHasEquipedKitchen": { "title": "Has Equipped Kitchen", "type": "boolean", "description": "Only include listings with equipped kitchen.", "default": false }, "featureSearchHasFurniture": { "title": "Has Furniture", "type": "boolean", "description": "Only include listings with furniture.", "default": false }, "featureSearchHasParking": { "title": "Has Parking", "type": "boolean", "description": "Only include listings with parking.", "default": false }, "featureSearchHasBalcony": { "title": "Has Balcony", "type": "boolean", "description": "Only include listings with balcony.", "default": false }, "featureSearchHasMediaVideos": { "title": "Has Videos", "type": "boolean", "description": "Only include listings with video.", "default": false }, "featureSearchHasMediaVirtualVisit": { "title": "Has Virtual Visit (Feature)", "type": "boolean", "description": "Only include listings with virtual visit (feature flag).", "default": 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 } } } } } } } } } }