{ "openapi": "3.0.1", "info": { "title": "Spotahome Mid-Term Rentals Scraper", "description": "Scrape Spotahome.com - the mid/long-term furnished rental marketplace covering 92 cities across Europe, the UAE and Turkey. Search rooms, apartments, studios and residences by city, price, bedrooms and move-in date, or fetch specific listing URLs.", "version": "1.0", "x-build-id": "s2HPdbSSQ3IvTaXmf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~spotahome-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~spotahome-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~spotahome-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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", "required": [ "mode", "city" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byUrls" ], "type": "string", "description": "What to fetch.", "default": "search" }, "city": { "title": "City (mode=search)", "enum": [ "alicante", "almeria", "amsterdam", "athens", "barcelona", "berlin", "bilbao", "bologna", "brescia", "brussels", "budapest", "cagliari", "cartagena", "coimbra", "cologne", "copenhagen", "cadiz", "cordoba", "dubai", "dublin", "dusseldorf", "edinburgh", "florence", "frankfurt", "galway", "gdansk", "genoa", "ghent", "glasgow", "granada", "graz", "hamburg", "huelva", "jaen", "katowice", "kaunas", "krakow", "leipzig", "lille", "lisbon", "liege", "ljubljana", "london", "lublin", "luxembourg", "lyon", "madrid", "manchester", "marseille", "milan", "montpellier", "munich", "murcia", "malaga", "naples", "nice", "nicosia", "nottingham", "oviedo", "padua", "pamplona", "paris", "perugia", "porto", "poznan", "prague", "riga", "rome", "rotterdam", "salamanca", "santander", "setubal", "seville", "stockholm", "stuttgart", "tallinn", "thessaloniki", "toulouse", "trento", "turin", "valencia", "valladolid", "valletta", "vienna", "vigo", "vilnius", "warsaw", "wroclaw", "zaragoza", "zurich", "istanbul", "lodz" ], "type": "string", "description": "Which of Spotahome's 92 cities to browse.", "default": "barcelona" }, "propertyType": { "title": "Property type (mode=search)", "enum": [ "all", "rooms", "apartments", "studios", "residences" ], "type": "string", "description": "Type of accommodation to browse.", "default": "all" }, "bedrooms": { "title": "Bedrooms (mode=search, propertyType=apartments only)", "enum": [ "any", "1", "2", "3", "3more" ], "type": "string", "description": "Restrict apartment listings to a specific bedroom count. Only applies when propertyType=apartments.", "default": "any" }, "minPrice": { "title": "Min price per month (EUR)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only browse listings priced at or above this, in the selected city's local currency (EUR for most cities; GBP/CHF/DKK/SEK/CZK/HUF/PLN/TRY/AED for a few non-Eurozone cities — see README). Applied server-side on Spotahome's own search (not just a post-filter), so narrow ranges stay fast." }, "maxPrice": { "title": "Max price per month (EUR)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only browse listings priced at or below this, in the selected city's local currency (EUR for most cities; GBP/CHF/DKK/SEK/CZK/HUF/PLN/TRY/AED for a few non-Eurozone cities — see README). Applied server-side on Spotahome's own search (not just a post-filter), so narrow ranges stay fast." }, "bathrooms": { "title": "Bathrooms (mode=search)", "enum": [ "any", "1", "2", "3" ], "type": "string", "description": "Restrict results to listings with this exact bathroom count.", "default": "any" }, "moveInFrom": { "title": "Move-in date from (mode=search)", "type": "string", "description": "Only browse listings available to move into on or after this date (YYYY-MM-DD)." }, "moveInTo": { "title": "Move-in date to (mode=search)", "type": "string", "description": "Only browse listings available to move into on or before this date (YYYY-MM-DD)." }, "noDeposit": { "title": "No-deposit listings only (mode=search)", "type": "boolean", "description": "Only keep listings that don't require a security deposit.", "default": false }, "instantBooking": { "title": "Instant-booking listings only (mode=search)", "type": "boolean", "description": "Only keep listings that can be booked instantly (no landlord approval wait). Applied server-side on Spotahome's own search.", "default": false }, "verifiedOnly": { "title": "Verified listings only (mode=search)", "type": "boolean", "description": "Only keep listings Spotahome has physically verified. Applied server-side on Spotahome's own search.", "default": false }, "minBedrooms": { "title": "Min bedrooms (post-filter)", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with fewer bedrooms than this. Only meaningful with includeDetails=true (bedroom count comes from the listing's detail page)." }, "startUrls": { "title": "Listing URLs (mode=byUrls)", "type": "array", "description": "Direct Spotahome.com listing URLs to fetch, e.g. `https://www.spotahome.com/barcelona/for-rent:rooms/1003961`.", "default": [], "items": { "type": "string" } }, "includeDetails": { "title": "Fetch full detail page per listing (mode=search)", "type": "boolean", "description": "When on, fetches each listing's detail page for extra fields (address, coordinates, bedrooms/bathrooms, amenities, lease terms, full photo gallery). Slower but far more complete.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted records.", "default": 30 } } }, "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 } } } } } } } } } }