{
  "openapi": "3.0.1",
  "info": {
    "title": "Idealista Rental Yield Finder - Spain, Portugal, Italy",
    "description": "Gross rental yield and market stats per area and per district from live idealista sale and rent listings (Spain, Portugal, Italy): median and quartile price per m², asking price and rent, yield by rooms, price drops, new listings. Comparison sorted by yield. $0.05 per area report.",
    "version": "0.1",
    "x-build-id": "GFKjfyZsBjWNedYZ2"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/amitaviv~idealista-rental-yield-finder/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-amitaviv-idealista-rental-yield-finder",
        "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/amitaviv~idealista-rental-yield-finder/runs": {
      "post": {
        "operationId": "runs-sync-amitaviv-idealista-rental-yield-finder",
        "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/amitaviv~idealista-rental-yield-finder/run-sync": {
      "post": {
        "operationId": "run-sync-amitaviv-idealista-rental-yield-finder",
        "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": [
          "areas"
        ],
        "properties": {
          "areas": {
            "title": "Areas",
            "type": "array",
            "description": "One area per line: an idealista homes search URL (sale or rent, e.g. https://www.idealista.com/venta-viviendas/madrid/centro/) or a location slug as it appears in idealista URLs (madrid-madrid, madrid/centro, barcelona-barcelona; prefix pt: or it: for Portugal or Italy, e.g. pt:lisboa, it:milano-milano). The matching sale and rent searches are read for each area. Filters in the URL (rooms, size, type, features) are applied to both sides; price and publication-date filters are not applied. Map views, page numbers and sort orders are ignored, and URLs without https:// are accepted. Offices, premises, garages, land and new-build (obra nueva) searches are not supported. Each area gives one report (one charged 'area-report' event).",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country for location slugs",
            "enum": [
              "ES",
              "PT",
              "IT"
            ],
            "type": "string",
            "description": "Which idealista site a slug without a pt: / it: prefix belongs to: ES (default), PT or IT. URLs carry their own site.",
            "default": "ES"
          },
          "includeSubAreas": {
            "title": "Also report every sub-area (districts, neighbourhoods)",
            "type": "boolean",
            "description": "One more report for each place idealista lists one level below the area (a city's districts, a district's neighbourhoods, a Portuguese municipality's parishes). Each sub-area report is charged like an area report. Example: madrid/centro with this on gave 7 reports (Centro and its 6 neighbourhoods). Default off: one report per area.",
            "default": false
          },
          "maxSubAreas": {
            "title": "Maximum sub-areas per area",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Only with sub-areas on. Caps the number of sub-area reports (and so the cost) per area, 1 to 200; default 50. Sub-areas are taken in idealista's order (alphabetical).",
            "default": 50
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "homes",
              "flats",
              "houses"
            ],
            "type": "string",
            "description": "homes (default): every home type. Flats: idealista's 'pisos' (ES), 'apartamentos' (PT), 'appartamenti' (IT) filter. Houses: 'chalets' (ES), 'moradias' (PT), 'case indipendenti' (IT).",
            "default": "homes"
          },
          "rooms": {
            "title": "Rooms",
            "type": "array",
            "description": "Optional: only homes with these numbers of rooms, any of 0, 1, 2, 3, 4+ (one per line). Spain and Portugal count bedrooms (0 = studio, T0); Italy counts all rooms including the living room (1 = monolocale; 0 is not available there). Every report also splits its figures by rooms (0-1, 2, 3, 4+) without this filter; the field roomsCountedAs says which way the rooms were counted.",
            "items": {
              "type": "string"
            }
          },
          "minSizeM2": {
            "title": "Minimum size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional, in square metres, e.g. 80. idealista offers 60, 80, 100, 120, 140, 160, 180, 200, 300, 400 m²: other values are rounded down to the nearest of these; below 60 no minimum is applied (the report says so)."
          },
          "maxSizeM2": {
            "title": "Maximum size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional, in square metres, e.g. 120. Rounded up to the nearest value idealista offers (60 to 400 m²); above 400 no maximum is applied (the report says so)."
          },
          "rentType": {
            "title": "Rentals counted",
            "enum": [
              "long-term",
              "all"
            ],
            "type": "string",
            "description": "Seasonal and temporary lets ask much higher monthly rents. By default the rent side uses idealista's own long-term filter, and the report also gives the number of rentals of every kind.",
            "default": "long-term"
          },
          "sampleSize": {
            "title": "Listings read per side (sample size)",
            "minimum": 60,
            "maximum": 360,
            "type": "integer",
            "description": "Sides (sale or rent) with up to this many listings plus 120 (4 more results pages) are read in full, so their figures are exact: at the default 240, sides of up to 360 listings. Larger sides are sampled: this many listings on results pages spread evenly over the price range, weighted by the share of the list each page stands for. 60 to 360; larger samples are more precise and take longer, the price per report is the same.",
            "default": 240
          },
          "debug": {
            "title": "Debug",
            "type": "boolean",
            "description": "Default off; not needed for normal use. Saves the first results pages and any block page to the key-value store and logs session details.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}