{
  "openapi": "3.0.1",
  "info": {
    "title": "Idealista Scraper - Spain Rental Listings",
    "description": "Scrape Spain rental listings from idealista.com search URLs: monthly rent, rooms, m2, price per m2, floor and lift, neighbourhood, agency, listing date, price drops and photos. Homes, rooms, offices, premises and garages for rent. Independent tool, not affiliated with idealista.",
    "version": "0.1",
    "x-build-id": "SLk4758IE5SvzObnK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~idealista-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-idealista-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/scrapesage~idealista-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-idealista-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/scrapesage~idealista-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-idealista-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": {
          "startUrls": {
            "title": "idealista.com rental search URLs",
            "type": "array",
            "description": "idealista.com <b>rental</b> search URLs, one per line. Build a search on idealista.com with your filters (city, district, price, size ...), then paste the URL. Homes, rooms, offices, premises and garages for rent all work, and so do new-build developments (<code>/venta-obranueva/</code>). Sale searches (<code>/venta-viviendas/</code> ...) and single-listing pages (<code>/inmueble/...</code>) are skipped at no cost, because idealista does not serve them to automated tools. <b>Leave empty and the run returns a small sample.</b>",
            "items": {
              "type": "string"
            }
          },
          "startUrlsFromFile": {
            "title": "Import URLs from a file",
            "type": "string",
            "description": "Bulk-load idealista.com rental search URLs. Either <b>paste the whole list</b> (one per line), or give <b>a single link</b> to a public <code>.txt</code>/<code>.csv</code>, a Google Sheet/Drive link, or an Apify key-value-store record. A file that cannot be read says so and charges nothing."
          },
          "maxPagesPerUrl": {
            "title": "Max pages per URL",
            "minimum": 1,
            "type": "integer",
            "description": "How many result pages to follow for each start URL (about 30 listings per page).",
            "default": 10
          },
          "maxItems": {
            "title": "Max listings (total)",
            "minimum": 1,
            "type": "integer",
            "description": "Overall cap across all URLs. You are only charged for listings actually saved.",
            "default": 1000
          },
          "outputFields": {
            "title": "Output fields (leave empty for all)",
            "type": "array",
            "description": "Pick the fields you want and every record is trimmed to exactly those - handy for lean CSV/Sheets exports.",
            "items": {
              "type": "string",
              "enum": [
                "type",
                "id",
                "title",
                "url",
                "price",
                "currency",
                "rooms",
                "areaSqm",
                "pricePerSqm",
                "floor",
                "description",
                "agent",
                "isNew",
                "tags",
                "image",
                "sourceUrl",
                "scrapedAt",
                "operation",
                "priceUnit",
                "propertyType",
                "street",
                "neighborhood",
                "city",
                "floorNumber",
                "exterior",
                "hasElevator",
                "parkingIncluded",
                "smokingAllowed",
                "features",
                "previousPrice",
                "priceDropPercent",
                "listedText",
                "listedDate",
                "isProfessional",
                "agentUrl",
                "agentLogo",
                "imageCount",
                "hasVideo",
                "hasVirtualTour",
                "hasFloorPlan",
                "onlineBooking"
              ],
              "enumTitles": [
                "Record type (type)",
                "Id (id)",
                "Title (title)",
                "URL (url)",
                "Price (price)",
                "Currency (currency)",
                "Rooms (rooms)",
                "Area m2 (areaSqm)",
                "Price per m2 (pricePerSqm)",
                "Floor (floor)",
                "Description (description)",
                "Agent (agent)",
                "New build (isNew)",
                "Tags (tags)",
                "Image (image)",
                "Source URL (sourceUrl)",
                "Scraped at (scrapedAt)",
                "Operation (operation)",
                "Price unit (priceUnit)",
                "Property type (propertyType)",
                "Street (street)",
                "Neighborhood (neighborhood)",
                "City (city)",
                "Floor number (floorNumber)",
                "Exterior (exterior)",
                "Elevator (hasElevator)",
                "Parking included (parkingIncluded)",
                "Smoking allowed (smokingAllowed)",
                "Features (features)",
                "Previous price (previousPrice)",
                "Price drop % (priceDropPercent)",
                "Listed text (listedText)",
                "Listed date (listedDate)",
                "Professional advertiser (isProfessional)",
                "Agent page (agentUrl)",
                "Agent logo (agentLogo)",
                "Photo count (imageCount)",
                "Has video (hasVideo)",
                "Has virtual tour (hasVirtualTour)",
                "Has floor plan (hasFloorPlan)",
                "Online booking (onlineBooking)"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}