{ "openapi": "3.0.1", "info": { "title": "Spotahome Scraper - Mid-Term Rentals, Rooms & Prices in Europe", "description": "Scrape Spotahome mid-term rentals in 228 European cities: rent, bills, deposit, rooms, size, amenities, map position, photos and landlord score. Add views, favorites, fees, monthly prices, booked dates and landlord stats. 21 filters, all cities in one run, only new listings. For rent market study.", "version": "1.0", "x-build-id": "xNO758LQye1tfluME" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/normdata~spotahome-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-normdata-spotahome-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/normdata~spotahome-scraper/runs": { "post": { "operationId": "runs-sync-normdata-spotahome-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/normdata~spotahome-scraper/run-sync": { "post": { "operationId": "run-sync-normdata-spotahome-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": { "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Stop after this many listings in total. Leave empty for no limit. The Apify Free plan is always capped at 10." }, "cities": { "title": "Cities", "type": "array", "description": "Spotahome cities to search. Empty = all 228 cities, biggest first.", "items": { "type": "string", "enum": [ "albacete", "albufeira", "alcobendas", "alcorcon", "alghero", "alicante", "almeria", "amsterdam", "ancona", "annecy", "antwerp", "anzio", "asturias", "athens", "aveiro", "aversa", "avila", "badajoz", "badalona", "barcelona", "bari", "bayonne", "bellaterra", "benalmadena", "bergamo", "berlin", "bielefeld", "bilbao", "birmingham", "blanes", "bochum", "bollate", "bologna", "bonn", "bordeaux", "bradford", "braga", "braunschweig", "brescia", "brindisi", "brussels", "budapest", "burgos", "caceres", "cadiz", "caen", "cagliari", "calimera", "cambrils", "cannes", "cartagena", "caserta", "catania", "cattolica", "charleroi", "ciampino", "coimbra", "cologne", "como", "copenhagen", "cordoba", "corsico", "cosenza", "coventry", "cuenca", "dresden", "dublin", "dusseldorf", "edinburgh", "elche", "essen", "estepona", "faro", "ferrara", "florence", "foggia", "forli", "frankfurt", "fuengirola", "fuenlabrada", "funchal", "gandia", "gdansk", "genoa", "getafe", "ghent", "gijon", "gerona", "glasgow", "granada", "graz", "grenoble", "grugliasco", "guadalajara", "guimaraes", "hamburg", "huelva", "huesca", "ibiza", "istanbul", "jaen", "katowice", "kaunas", "krakow", "laquila", "lagos", "leeds", "leganes", "leipzig", "leon", "liege", "lille", "lisbon", "liverpool", "livorno", "ljubljana", "lerida", "lodz", "logrono", "london", "loule", "loures", "lublin", "ludwigsburg", "luxembourg", "lyon", "madrid", "magdeburg", "mainz", "majadahonda", "malaga", "manchester", "mannheim", "marbella", "marotta", "marseille", "menorca", "messina", "milan", "mislata", "modena", "monopoli", "montpellier", "monza", "mostoles", "mulhouse", "munich", "murcia", "nantes", "naples", "neuss", "nice", "nicosia", "nottingham", "nuremberg", "orleans", "oviedo", "padua", "palermo", "pamplona", "paris", "parla", "parma", "paterna", "perugia", "pescara", "pisa", "pompei", "portimao", "porto", "potsdam", "poznan", "prague", "rennes", "reus", "rieti", "riga", "rimini", "rome", "rotterdam", "rouen", "rovereto", "salamanca", "salerno", "salou", "santander", "sassari", "savona", "setubal", "seville", "siena", "stockholm", "strasbourg", "stuttgart", "siracusa", "tarifa", "tarragona", "tavira", "terni", "teruel", "thessaloniki", "toledo", "torrente", "toulouse", "tours", "trento", "treviso", "trieste", "turin", "udine", "valdemoro", "valencia", "valladolid", "vallendar", "varese", "vendrell", "venice", "verona", "vicenza", "vienna", "vigo", "villeurbanne", "vilnius", "viseu", "warsaw", "wroclaw", "zaragoza", "zurich" ], "enumTitles": [ "Albacete (Spain)", "Albufeira (Portugal)", "Alcobendas (Spain)", "Alcorcón (Spain)", "Alghero (Italy)", "Alicante (Spain)", "Almería (Spain)", "Amsterdam (Netherlands)", "Ancona (Italy)", "Annecy (France)", "Antwerp (Belgium)", "Anzio (Italy)", "Asturias (Spain)", "Athens (Greece)", "Aveiro (Portugal)", "Aversa (Italy)", "Avila (Spain)", "Badajoz (Spain)", "Badalona (Spain)", "Barcelona (Spain)", "Bari (Italy)", "Bayonne (France)", "Bellaterra (Spain)", "Benalmádena (Spain)", "Bergamo (Italy)", "Berlin (Germany)", "Bielefeld (Germany)", "Bilbao (Spain)", "Birmingham (UK)", "Blanes (Spain)", "Bochum (Germany)", "Bollate (Italy)", "Bologna (Italy)", "Bonn (Germany)", "Bordeaux (France)", "Bradford (UK)", "Braga (Portugal)", "Braunschweig (Germany)", "Brescia (Italy)", "Brindisi (Italy)", "Brussels (Belgium)", "Budapest (Hungary)", "Burgos (Spain)", "Cáceres (Spain)", "Cádiz (Spain)", "Caen (France)", "Cagliari (Italy)", "Calimera (Italy)", "Cambrils (Spain)", "Cannes (France)", "Cartagena (Spain)", "Caserta (Italy)", "Catania (Italy)", "Cattolica (Italy)", "Charleroi (Belgium)", "Ciampino (Italy)", "Coimbra (Portugal)", "Cologne (Germany)", "Como (Italy)", "Copenhagen (Denmark)", "Córdoba (Spain)", "Corsico (Italy)", "Cosenza (Italy)", "Coventry (UK)", "Cuenca (Spain)", "Dresden (Germany)", "Dublin (Ireland)", "Düsseldorf (Germany)", "Edinburgh (UK)", "Elche (Spain)", "Essen (Germany)", "Estepona (Spain)", "Faro (Portugal)", "Ferrara (Italy)", "Florence (Italy)", "Foggia (Italy)", "Forlì (Italy)", "Frankfurt (Germany)", "Fuengirola (Spain)", "Fuenlabrada (Spain)", "Funchal (Portugal)", "Gandia (Spain)", "Gdańsk (Poland)", "Genoa (Italy)", "Getafe (Spain)", "Ghent (Belgium)", "Gijon (Spain)", "Girona (Spain)", "Glasgow (UK)", "Granada (Spain)", "Graz (Austria)", "Grenoble (France)", "Grugliasco (Italy)", "Guadalajara (Spain)", "Guimarães (Portugal)", "Hamburg (Germany)", "Huelva (Spain)", "Huesca (Spain)", "Ibiza (Spain)", "Istanbul (Turkey)", "Jaén (Spain)", "Katowice (Poland)", "Kaunas (Lithuania)", "Kraków (Poland)", "L'Aquila (Italy)", "Lagos (Portugal)", "Leeds (UK)", "Leganés (Spain)", "Leipzig (Germany)", "León (Spain)", "Liège (Belgium)", "Lille (France)", "Lisbon (Portugal)", "Liverpool (UK)", "Livorno (Italy)", "Ljubljana (Slovenia)", "Lleida (Spain)", "Łódź (Poland)", "Logroño (Spain)", "London (UK)", "Loulé (Portugal)", "Loures (Portugal)", "Lublin (Poland)", "Ludwigsburg (Germany)", "Luxembourg (Luxembourg)", "Lyon (France)", "Madrid (Spain)", "Magdeburg (Germany)", "Mainz (Germany)", "Majadahonda (Spain)", "Málaga (Spain)", "Manchester (UK)", "Mannheim (Germany)", "Marbella (Spain)", "Marotta (Italy)", "Marseille (France)", "Menorca (Spain)", "Messina (Italy)", "Milan (Italy)", "Mislata (Spain)", "Modena (Italy)", "Monopoli (Italy)", "Montpellier (France)", "Monza (Italy)", "Móstoles (Spain)", "Mulhouse (France)", "Munich (Germany)", "Murcia (Spain)", "Nantes (France)", "Naples (Italy)", "Neuss (Germany)", "Nice (France)", "Nicosia (Cyprus)", "Nottingham (UK)", "Nuremberg (Germany)", "Orléans (France)", "Oviedo (Spain)", "Padua (Italy)", "Palermo (Italy)", "Pamplona (Spain)", "Paris (France)", "Parla (Spain)", "Parma (Italy)", "Paterna (Spain)", "Perugia (Italy)", "Pescara (Italy)", "Pisa (Italy)", "Pompeii (Italy)", "Portimão (Portugal)", "Porto (Portugal)", "Potsdam (Germany)", "Poznań (Poland)", "Prague (Czechia)", "Rennes (France)", "Reus (Spain)", "Rieti (Italy)", "Riga (Latvia)", "Rimini (Italy)", "Rome (Italy)", "Rotterdam (Netherlands)", "Rouen (France)", "Rovereto (Italy)", "Salamanca (Spain)", "Salerno (Italy)", "Salou (Spain)", "Santander (Spain)", "Sassari (Italy)", "Savona (Italy)", "Setúbal (Portugal)", "Seville (Spain)", "Siena (Italy)", "Stockholm (Sweden)", "Strasbourg (France)", "Stuttgart (Germany)", "Syracuse (Italy)", "Tarifa (Spain)", "Tarragona (Spain)", "Tavira (Portugal)", "Terni (Italy)", "Teruel (Spain)", "Thessaloniki (Greece)", "Toledo (Spain)", "Torrente (Spain)", "Toulouse (France)", "Tours (France)", "Trento (Italy)", "Treviso (Italy)", "Trieste (Italy)", "Turin (Italy)", "Udine (Italy)", "Valdemoro (Spain)", "Valencia (Spain)", "Valladolid (Spain)", "Vallendar (Germany)", "Varese (Italy)", "Vendrell (Spain)", "Venice (Italy)", "Verona (Italy)", "Vicenza (Italy)", "Vienna (Austria)", "Vigo (Spain)", "Villeurbanne (France)", "Vilnius (Lithuania)", "Viseu (Portugal)", "Warsaw (Poland)", "Wrocław (Poland)", "Zaragoza (Spain)", "Zurich (Switzerland)" ] } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Empty = every type.", "items": { "type": "string", "enum": [ "apartment", "room", "studio", "residence" ], "enumTitles": [ "Apartment", "Room in a shared flat", "Studio", "Student or coliving residence" ] } }, "sortBy": { "title": "Sort by", "enum": [ "newest", "lowestPrice" ], "type": "string", "description": "Order of the listings inside each city. Empty = newest first." }, "includeDetails": { "title": "Listing details (views, favorites, fees, monthly prices, landlord)", "type": "boolean", "description": "Also read each listing page for its views, favorites and interested tenants, full description, highlights, minimum and maximum stay, deposit, admin fee, one-time fees, bills cost and total monthly cost, price for every month, booked dates and move-in windows, floor, heating, A/C, house rules, required documents, other rooms in the flat, all photos, videos, and the landlord name, type, listings, response time and rate. Charged per listing as an add-on." }, "minPrice": { "title": "Minimum monthly rent", "minimum": 0, "type": "integer", "description": "In the city currency (EUR, GBP, PLN, CHF...). Checks the lowest monthly price." }, "maxPrice": { "title": "Maximum monthly rent", "minimum": 0, "type": "integer", "description": "In the city currency. Checks the lowest monthly price." }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Bedrooms in the property (for rooms: in the shared flat).", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "1 bedroom", "2 bedrooms", "3 bedrooms", "4 or more bedrooms" ] } }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "Bathrooms in the property.", "items": { "type": "string", "enum": [ "1", "2", "3" ], "enumTitles": [ "1 bathroom", "2 bathrooms", "3 bathrooms" ] } }, "tenants": { "title": "Number of tenants", "minimum": 0, "maximum": 10, "type": "integer", "description": "Keep only listings that take at least this many people (2 to 10)." }, "minAreaM2": { "title": "Minimum size (m²)", "minimum": 0, "type": "integer", "description": "Size of the property, in square meters. Listings without a size are left out." }, "availableBy": { "title": "Available by", "type": "string", "description": "Keep only listings you can move into on or before this date, like 2027-01-15 or \"1 month\" from today." }, "amenities": { "title": "Amenities", "type": "array", "description": "Keep only listings with all of these.", "items": { "type": "string", "enum": [ "airConditioning", "heating", "elevator", "balcony", "washingMachine", "dryer", "dishwasher", "oven", "parking", "pool", "furnished", "kitchen", "wifi", "doorman", "tv", "accessible", "exterior", "privateBathroom", "desk", "independentKey" ], "enumTitles": [ "Air conditioning", "Heating", "Elevator", "Balcony or terrace", "Washing machine", "Dryer", "Dishwasher", "Oven", "Parking", "Pool access", "Furnished", "Equipped kitchen", "Wi-Fi", "Doorman or reception", "TV", "Wheelchair accessible", "Exterior (street facing)", "Private bathroom", "Desk", "Independent key" ] } }, "billsIncluded": { "title": "Bills included", "type": "array", "description": "Keep only listings whose rent includes all of these.", "items": { "type": "string", "enum": [ "wifi", "electricity", "water", "gas", "heating", "cleaning", "councilTax", "bedLinen", "meals" ], "enumTitles": [ "Wi-Fi", "Electricity", "Water", "Gas", "Central heating", "Cleaning service", "Council tax", "Bed linen", "Meal service" ] } }, "allBillsIncluded": { "title": "Only all bills included", "type": "boolean", "description": "Keep only listings whose rent includes every bill." }, "suitableFor": { "title": "Suitable for", "type": "array", "description": "Keep only listings open to all of these.", "items": { "type": "string", "enum": [ "students", "professionals", "couples" ], "enumTitles": [ "Students", "Professionals", "Couples" ] } }, "gender": { "title": "Tenant gender", "enum": [ "any", "onlyFemales", "onlyMales" ], "type": "string", "description": "Empty = any." }, "bedTypes": { "title": "Bed type", "type": "array", "description": "Keep only listings with one of these beds.", "items": { "type": "string", "enum": [ "single", "double", "twin", "bunk" ], "enumTitles": [ "Single bed", "Double bed", "Twin beds", "Bunk beds" ] } }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Keep only listings that allow pets." }, "smokingAllowed": { "title": "Smoking allowed", "type": "boolean", "description": "Keep only listings that allow smoking." }, "verifiedOnly": { "title": "Only checked by Spotahome", "type": "boolean", "description": "Keep only listings a Spotahome homechecker visited and photographed." }, "instantBookingOnly": { "title": "Only instant booking", "type": "boolean", "description": "Keep only listings you can book without waiting for the landlord." }, "noDepositOnly": { "title": "Only no deposit", "type": "boolean", "description": "Keep only listings with no security deposit." }, "bestChoiceOnly": { "title": "Only best choice", "type": "boolean", "description": "Keep only listings Spotahome marks as \"Best choice\"." }, "permanentContractOnly": { "title": "Only long-term contract", "type": "boolean", "description": "Keep only listings that also offer a permanent (long-term) contract." }, "discountOnly": { "title": "Only with a discount", "type": "boolean", "description": "Keep only listings with a discount for longer stays." }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Skip listings saved by earlier runs with the same monitor name." }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Runs with the same name share their history. Use a different name for each schedule." }, "startUrls": { "title": "Links", "type": "array", "description": "Searches copied from the site (https://www.spotahome.com/s/lisbon/for-rent:apartments?features[]=elevator) or listing pages (https://www.spotahome.com/madrid/for-rent:rooms/91623).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } } } }, "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 } } } } } } } } } }