{
  "openapi": "3.0.1",
  "info": {
    "title": "ImmoScout24 Scraper - Germany and Austria",
    "description": "Scrape ImmoScout24 listings from immobilienscout24.de and immobilienscout24.at: prices, rent costs, areas, energy data, coordinates, images, and seller contacts. Search by URL or location, with monitoring mode for new listings.",
    "version": "0.1",
    "x-build-id": "FMrxEeCrE36BcDDu5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/phantom_coder~immoscout24-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-phantom_coder-immoscout24-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/phantom_coder~immoscout24-scraper/runs": {
      "post": {
        "operationId": "runs-sync-phantom_coder-immoscout24-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/phantom_coder~immoscout24-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-phantom_coder-immoscout24-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": "🔗 Start URLs",
            "type": "array",
            "description": "Search or listing URLs from immobilienscout24.de or immobilienscout24.at. Run a search on the website, then copy the URL from the address bar. Listing URLs (<code>…/expose/…</code>) scrape a single listing.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "location": {
            "title": "📍 Location",
            "type": "string",
            "description": "City, district, or region, for example <code>München</code>, <code>Hamburg Altona</code>, or <code>Graz</code>. In Austria you can also use a state (<code>Tirol</code>) or a 4-digit postcode (<code>8010</code>)."
          },
          "country": {
            "title": "🌍 Country",
            "enum": [
              "DE",
              "AT"
            ],
            "type": "string",
            "description": "Search immobilienscout24.de or immobilienscout24.at.",
            "default": "DE"
          },
          "transferType": {
            "title": "🏷️ Rent or buy",
            "enum": [
              "rent",
              "buy"
            ],
            "type": "string",
            "description": "Properties to rent or to buy.",
            "default": "rent"
          },
          "propertyType": {
            "title": "🏠 Property type",
            "enum": [
              "apartment",
              "house"
            ],
            "type": "string",
            "description": "Apartments or houses. For other property types, paste a search URL.",
            "default": "apartment"
          },
          "minPrice": {
            "title": "💶 Min price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum monthly rent or purchase price, in euros."
          },
          "maxPrice": {
            "title": "💶 Max price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum monthly rent or purchase price, in euros."
          },
          "minRooms": {
            "title": "🛏️ Min rooms",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum number of rooms."
          },
          "maxRooms": {
            "title": "🛏️ Max rooms",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of rooms."
          },
          "minLivingSpace": {
            "title": "📐 Min living space (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum living space, in m²."
          },
          "maxLivingSpace": {
            "title": "📐 Max living space (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum living space, in m²."
          },
          "maxItems": {
            "title": "🔢 Max listings",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listings to save in this run, across all URLs. Set to <code>0</code> for no limit.",
            "default": 100
          },
          "includeDetails": {
            "title": "📄 Include full listing details",
            "type": "boolean",
            "description": "Load each listing page for descriptions, all images, costs, energy data, features, and seller contacts. Turn off for a faster run with only search result data (price, area, rooms, address, and first image). The price per listing is the same either way.",
            "default": true
          },
          "monitoringMode": {
            "title": "🔔 Monitoring mode (only new listings)",
            "type": "boolean",
            "description": "Only save listings that weren't in the search on previous runs, so you pay only for new listings. The first run saves listings up to <b>Max listings</b> and records the rest of the search as the starting point. Schedule the Actor to get new listings every hour or day.",
            "default": false
          },
          "monitoringName": {
            "title": "🏷️ Monitoring name",
            "type": "string",
            "description": "Optional. Keeps a separate list of seen listings, for example when two schedules watch the same search for different people. Leave empty to share one list per search."
          },
          "includeRawData": {
            "title": "🧾 Include raw data",
            "type": "boolean",
            "description": "Add the original ImmoScout24 responses in a <code>raw</code> field, for fields not in the standard output. Makes results much larger.",
            "default": false
          },
          "maxConcurrency": {
            "title": "⚡ Max concurrency",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many listing detail pages to load at the same time.",
            "default": 10
          },
          "proxyConfiguration": {
            "title": "🛡️ Proxy configuration",
            "type": "object",
            "description": "Not needed in most cases. Enable Apify Proxy only if the log reports blocked requests.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}