{
"openapi": "3.0.1",
"info": {
"title": "Idealista Scraper: Spain Homes & Rooms for Sale or Rent",
"description": "Scrape idealista.com listings for many Spanish cities, districts and towns in one run: homes, new builds, rooms, offices, premises, garages, land and buildings, for sale or rent. Price, price drops, size, bedrooms, floor, agency, photos and links.",
"version": "0.1",
"x-build-id": "qJ84G3HBmhujbvPjf"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/nextgensda~idealista-listings/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-nextgensda-idealista-listings",
"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/nextgensda~idealista-listings/runs": {
"post": {
"operationId": "runs-sync-nextgensda-idealista-listings",
"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/nextgensda~idealista-listings/run-sync": {
"post": {
"operationId": "run-sync-nextgensda-idealista-listings",
"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": {
"searches": {
"title": "Searches",
"type": "array",
"description": "One search per entry: {\"location\": \"Chamberí, Madrid\", \"operation\": \"rent\"}. Optional per search: operation (sale, rent), propertyType, minPrice, maxPrice, minSize, maxSize, minBedrooms, sort; unset ones take the run-wide filters below. A location is a city, town, district or neighbourhood in Spain as you'd type it on idealista (\"Marbella\", \"Gràcia, Barcelona\"), or idealista's own path from a search URL (\"madrid-madrid\", \"madrid/chamberi\")."
},
"locations": {
"title": "Locations (run-wide filters)",
"type": "array",
"description": "Shortcut for many locations with the filters below.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Search URLs",
"type": "array",
"description": "idealista.com search result URLs, with any filters the site offers (e.g. https://www.idealista.com/alquiler-viviendas/barcelona/gracia/con-terraza/).",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"operation": {
"title": "Operation",
"enum": [
"sale",
"rent"
],
"type": "string",
"description": "Listings for sale or for rent.",
"default": "sale"
},
"propertyType": {
"title": "Property type",
"enum": [
"homes",
"new-homes",
"rooms",
"offices",
"premises",
"garages",
"land",
"storage",
"buildings"
],
"type": "string",
"description": "What to search for.",
"default": "homes"
},
"minPrice": {
"title": "Min price",
"minimum": 0,
"type": "integer",
"description": "EUR (per month for rent)."
},
"maxPrice": {
"title": "Max price",
"minimum": 0,
"type": "integer",
"description": "EUR (per month for rent)."
},
"minSize": {
"title": "Min size (m²)",
"minimum": 0,
"type": "integer",
"description": "At least this many square metres."
},
"maxSize": {
"title": "Max size (m²)",
"minimum": 0,
"type": "integer",
"description": "At most this many square metres."
},
"minBedrooms": {
"title": "Min bedrooms",
"minimum": 0,
"maximum": 4,
"type": "integer",
"description": "Homes only: at least this many bedrooms (4 = four or more)."
},
"sort": {
"title": "Sort",
"enum": [
"relevance",
"newest",
"oldest",
"price-asc",
"price-desc",
"price-per-m2-asc",
"price-per-m2-desc",
"size-asc",
"size-desc",
"price-drops"
],
"type": "string",
"description": "Order of the results.",
"default": "relevance"
},
"maxItemsPerSearch": {
"title": "Max listings per search",
"minimum": 1,
"maximum": 2500,
"type": "integer",
"description": "idealista serves up to 2,500 per search (50 pages of 50). Split a big area into districts, or use price ranges, to get more.",
"default": 150
},
"maxItems": {
"title": "Max listings in total",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "The run stops after this many listings.",
"default": 1000
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Spanish residential proxies are recommended. Custom proxy URLs can be http:// or socks5:// (socks5://user:pass@host:port); several URLs rotate when idealista refuses one.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "ES"
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}