{
  "openapi": "3.0.1",
  "info": {
    "title": "Immoweb Scraper - Belgium Property Listings, Prices & Agents",
    "description": "Scrape Immoweb.be, Belgium's biggest property site: houses, apartments, land, offices for sale or rent. Price, m², bedrooms, address, GPS, EPC, agency; details add-on with agency phone, e-mail, description, cadastral income. Filters, search links, monitor mode. $0.76 per 1,000 listings.",
    "version": "0.1",
    "x-build-id": "0NqNhw7wdnlB1LZT8"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~immoweb-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-immoweb-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/topapi~immoweb-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-immoweb-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/topapi~immoweb-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-immoweb-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": {
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Belgian cities or municipalities (all their localities are included, as on Immoweb), 4-digit postal codes (\"9000\", or several on one line: \"1000, 1050\"), districts (\"district: Gent\"), provinces (\"Antwerp province\", \"Brussels\", \"Limburg\") or \"Belgium\". One search per line. Leave empty to search all of Belgium.",
            "items": {
              "type": "string"
            }
          },
          "transaction": {
            "title": "For sale or for rent",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Listings for sale or for rent.",
            "default": "sale"
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "One search per type. 'Houses and apartments' is Immoweb's combined search.",
            "items": {
              "type": "string",
              "enum": [
                "house-and-apartment",
                "house",
                "apartment",
                "new-project-houses",
                "new-project-apartments",
                "kot",
                "land",
                "garage",
                "office",
                "commercial",
                "industry",
                "other"
              ],
              "enumTitles": [
                "Houses and apartments",
                "Houses",
                "Apartments",
                "New-build house projects",
                "New-build apartment projects",
                "Student rooms (kots, rent only)",
                "Land",
                "Garages and parking",
                "Offices",
                "Commercial property",
                "Industrial property",
                "Other"
              ]
            },
            "default": [
              "house-and-apartment"
            ]
          },
          "startUrls": {
            "title": "Immoweb links",
            "type": "array",
            "description": "Search result links copied from your browser (English, French or Dutch, with any filters, sort and location: https://www.immoweb.be/en/search/house/for-sale/gent/9000?countries=BE&minPrice=200000) and listing links (https://www.immoweb.be/en/classified/house/for-sale/seraing/4100/21989959). The link's own filters win over the filters below.",
            "items": {
              "type": "string"
            }
          },
          "listingIds": {
            "title": "Listing ids",
            "type": "array",
            "description": "Immoweb listing ids (the number at the end of a listing link) to re-check, one per line.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Price, or monthly rent for rentals."
          },
          "maxPrice": {
            "title": "Max price (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Price, or monthly rent for rentals."
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this many bedrooms."
          },
          "maxBedrooms": {
            "title": "Max bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at most this many bedrooms."
          },
          "minLivingArea": {
            "title": "Min living area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Living area at least this many m²."
          },
          "maxLivingArea": {
            "title": "Max living area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Living area at most this many m²."
          },
          "minLandArea": {
            "title": "Min land area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Land / plot at least this many m²."
          },
          "maxLandArea": {
            "title": "Max land area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Land / plot at most this many m²."
          },
          "minConstructionYear": {
            "title": "Built in or after",
            "minimum": 1000,
            "type": "integer",
            "description": "Built in this year or later."
          },
          "maxConstructionYear": {
            "title": "Built in or before",
            "minimum": 1000,
            "type": "integer",
            "description": "Built in this year or earlier."
          },
          "epcScores": {
            "title": "EPC (energy) scores",
            "type": "array",
            "description": "Only listings with one of these energy certificate scores.",
            "items": {
              "type": "string",
              "enum": [
                "A++",
                "A+",
                "A",
                "B",
                "C",
                "D",
                "E",
                "F",
                "G"
              ]
            }
          },
          "buildingConditions": {
            "title": "Building condition",
            "type": "array",
            "description": "Only listings in one of these conditions.",
            "items": {
              "type": "string",
              "enum": [
                "AS_NEW",
                "JUST_RENOVATED",
                "GOOD",
                "TO_BE_DONE_UP",
                "TO_RENOVATE",
                "TO_RESTORE"
              ],
              "enumTitles": [
                "As new",
                "Just renovated",
                "Good",
                "To be done up",
                "To renovate",
                "To restore"
              ]
            }
          },
          "propertySubtypes": {
            "title": "Property subtypes",
            "type": "array",
            "description": "Immoweb subtypes, e.g. VILLA, BUNGALOW, TOWN_HOUSE, MANSION, APARTMENT_BLOCK, MIXED_USE_BUILDING, DUPLEX, PENTHOUSE, FLAT_STUDIO, GROUND_FLOOR, LOFT, TRIPLEX, SERVICE_FLAT, KOT, BUILDING_LAND, OFFICES, WAREHOUSE, COMMERCIAL_PREMISES, LOCK_UP_GARAGE.",
            "items": {
              "type": "string"
            }
          },
          "minRooms": {
            "title": "Min rooms",
            "minimum": 0,
            "type": "integer",
            "description": "At least this many rooms."
          },
          "maxRooms": {
            "title": "Max rooms",
            "minimum": 0,
            "type": "integer",
            "description": "At most this many rooms."
          },
          "minFacades": {
            "title": "Min facades",
            "minimum": 0,
            "type": "integer",
            "description": "At least this many facades (2 = terraced, 3 = semi-detached, 4 = detached)."
          },
          "maxFacades": {
            "title": "Max facades",
            "minimum": 0,
            "type": "integer",
            "description": "At most this many facades."
          },
          "minParkingPlaces": {
            "title": "Min parking places",
            "minimum": 0,
            "type": "integer",
            "description": "At least this many parking places."
          },
          "minGardenArea": {
            "title": "Min garden area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Garden at least this many m²."
          },
          "minTerraceArea": {
            "title": "Min terrace area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Terrace at least this many m²."
          },
          "hasGarden": {
            "title": "With a garden",
            "type": "boolean",
            "description": "Only listings with a garden."
          },
          "hasTerrace": {
            "title": "With a terrace",
            "type": "boolean",
            "description": "Only listings with a terrace."
          },
          "hasTerraceOrGarden": {
            "title": "With a terrace or a garden",
            "type": "boolean",
            "description": "Only listings with a terrace or a garden."
          },
          "hasSwimmingPool": {
            "title": "With a swimming pool",
            "type": "boolean",
            "description": "Only listings with a swimming pool."
          },
          "hasLift": {
            "title": "With a lift",
            "type": "boolean",
            "description": "Only listings with a lift."
          },
          "hasFireplace": {
            "title": "With a fireplace",
            "type": "boolean",
            "description": "Only listings with a fireplace."
          },
          "hasDisabledAccess": {
            "title": "Accessible for people with disabilities",
            "type": "boolean",
            "description": "Only listings accessible for people with disabilities."
          },
          "isFurnished": {
            "title": "Furnished",
            "type": "boolean",
            "description": "Only furnished listings."
          },
          "isImmediatelyAvailable": {
            "title": "Immediately available",
            "type": "boolean",
            "description": "Only listings available now."
          },
          "isNewlyBuilt": {
            "title": "Newly built",
            "type": "boolean",
            "description": "Only newly built properties."
          },
          "isAnInvestmentProperty": {
            "title": "Investment property",
            "type": "boolean",
            "description": "Only properties sold as an investment."
          },
          "hasVirtualTour": {
            "title": "With a virtual tour",
            "type": "boolean",
            "description": "Only listings with a virtual tour."
          },
          "publicSale": {
            "title": "Public sales (auctions)",
            "enum": [
              "any",
              "exclude",
              "only"
            ],
            "type": "string",
            "description": "Include, exclude or keep only public sales (auctions)."
          },
          "lifeAnnuitySale": {
            "title": "Life annuity sales",
            "enum": [
              "any",
              "exclude",
              "only"
            ],
            "type": "string",
            "description": "Include, exclude or keep only life annuity sales (viager / lijfrente)."
          },
          "underOption": {
            "title": "Listings under option",
            "enum": [
              "any",
              "exclude",
              "only"
            ],
            "type": "string",
            "description": "Include, exclude or keep only listings under option."
          },
          "postedWithinDays": {
            "title": "Published in the last N days",
            "minimum": 1,
            "type": "integer",
            "description": "Immoweb's 'max days since activation'."
          },
          "modifiedWithinDays": {
            "title": "Updated in the last N days",
            "minimum": 1,
            "type": "integer",
            "description": "Immoweb's 'max days since last modification'."
          },
          "extraFilters": {
            "title": "Other Immoweb query parameters",
            "type": "object",
            "description": "Any other parameter of Immoweb's search, sent as is, e.g. {\"minKitchenSurface\": 10, \"isAWorkSpaceProperty\": true}."
          },
          "includeKeywords": {
            "title": "Keywords to include",
            "type": "array",
            "description": "Keep a listing only when its title (and its description, with details on) contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "keywordMatch": {
            "title": "Keyword match",
            "enum": [
              "any",
              "all"
            ],
            "type": "string",
            "description": "With several keywords to include: any of them, or all of them.",
            "default": "any"
          },
          "excludeKeywords": {
            "title": "Keywords to exclude",
            "type": "array",
            "description": "Drop a listing when its title (and description, with details on) contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "agencyNames": {
            "title": "Only these agencies",
            "type": "array",
            "description": "Keep listings whose agency name contains one of these.",
            "items": {
              "type": "string"
            }
          },
          "excludeAgencyNames": {
            "title": "Exclude these agencies",
            "type": "array",
            "description": "Drop listings whose agency name contains one of these.",
            "items": {
              "type": "string"
            }
          },
          "excludeProjects": {
            "title": "Exclude new-build projects",
            "type": "boolean",
            "description": "Drop project listings (a group of units with a price range)."
          },
          "withPriceOnly": {
            "title": "Only listings with a price",
            "type": "boolean",
            "description": "Drop listings whose price is on request."
          },
          "onlyPriceReduced": {
            "title": "Only price-reduced listings",
            "type": "boolean",
            "description": "Listings Immoweb shows with an old price or a 'new price' flag."
          },
          "minPriceDropPct": {
            "title": "Min price drop (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only listings whose price fell at least this much from the old price Immoweb shows."
          },
          "minPricePerSqm": {
            "title": "Min price per m² (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only sales whose price per m² is at least this."
          },
          "maxPricePerSqm": {
            "title": "Max price per m² (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only sales whose price per m² is at most this."
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "newest",
              "relevance",
              "cheapest",
              "most_expensive",
              "postal_code"
            ],
            "type": "string",
            "description": "Order of the results (Immoweb's own sort). Newest first suits monitoring.",
            "default": "newest"
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many listings in total (0 = no limit).",
            "default": 100
          },
          "maxItemsPerSearch": {
            "title": "Max listings per search",
            "minimum": 0,
            "type": "integer",
            "description": "Stop each search (location x type x sale/rent, or link) after this many listings."
          },
          "maxPagesPerSearch": {
            "title": "Max result pages per search",
            "minimum": 0,
            "type": "integer",
            "description": "60 listings a page."
          },
          "includeDetails": {
            "title": "Listing details (add-on)",
            "type": "boolean",
            "description": "Read each delivered listing's own page data: agency phone, e-mail, website and IPI number, full description (French / Dutch / English), EPC kWh/m² and reference, CO2, cadastral income, construction year, condition, facades, bathrooms, toilets, kitchen, garden / terrace size, parking, heating, flood zone, permits, views and saves, all photos, publication date and days on market. Charged per listing that carries them.",
            "default": false
          },
          "expandProjectUnits": {
            "title": "Deliver each unit of a new-build project",
            "type": "boolean",
            "description": "For project listings, also deliver each of the project's units (apartments or houses) as its own listing row.",
            "default": false
          },
          "includeSoldUnits": {
            "title": "Include sold project units",
            "type": "boolean",
            "description": "With project units on: also deliver units the project shows as sold (default: available units only).",
            "default": false
          },
          "splitLargeSearches": {
            "title": "Read searches past 9,960 listings",
            "type": "boolean",
            "description": "Immoweb pages through at most 9,960 listings per search. When a search has more and your max wants more, it is split by province, then by price band, so every listing can be reached.",
            "default": true
          },
          "language": {
            "title": "Link language",
            "enum": [
              "en",
              "fr",
              "nl"
            ],
            "type": "string",
            "description": "Language of the listing links in the rows.",
            "default": "en"
          },
          "deduplicate": {
            "title": "Deduplicate across searches",
            "type": "boolean",
            "description": "A listing found by two searches is delivered (and charged) once.",
            "default": true
          },
          "compact": {
            "title": "Compact rows",
            "type": "boolean",
            "description": "A short row (id, link, title, price, area, address, EPC, agency) without empty fields.",
            "default": false
          },
          "descriptionMaxLength": {
            "title": "Cut descriptions at N characters",
            "minimum": 0,
            "type": "integer",
            "description": "0 = full text."
          },
          "includeRawData": {
            "title": "Include Immoweb's own JSON",
            "type": "boolean",
            "description": "Add the site's search result object (and listing object, with details) as `raw`.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor mode (new and changed only)",
            "type": "boolean",
            "description": "Each run delivers only listings the earlier runs of the same input did not deliver, plus listings whose price changed. Schedule it to get new listings daily.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Keeps separate memories for separate monitors with the same input."
          },
          "emitPriceChanges": {
            "title": "Deliver price changes again",
            "type": "boolean",
            "description": "Monitor mode: deliver a listing again when its price changed (changeType price-changed).",
            "default": true
          },
          "emitUnchanged": {
            "title": "Deliver unchanged listings too",
            "type": "boolean",
            "description": "Monitor mode: deliver listings again even when nothing changed.",
            "default": false
          },
          "emitExpired": {
            "title": "Report listings gone from the site",
            "type": "boolean",
            "description": "A free row (changeType expired) for each listing an earlier run delivered that a search read to its end no longer shows.",
            "default": false
          },
          "resetMonitor": {
            "title": "Forget what earlier runs delivered",
            "type": "boolean",
            "description": "Monitor mode: start this monitor over (every listing counts as new once).",
            "default": false
          },
          "webhookUrl": {
            "title": "Notify a webhook",
            "type": "string",
            "description": "POST a summary with the first rows when a run delivers something (Slack and Discord webhook links get a message)."
          },
          "maxConcurrency": {
            "title": "Requests at once",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Requests in flight at once.",
            "default": 16
          },
          "maxRequestsPerMinute": {
            "title": "Max requests per minute",
            "minimum": 10,
            "maximum": 3000,
            "type": "integer",
            "description": "Pace limit for all requests to Immoweb."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed: the run starts on the platform's own connection and moves to Apify datacenter, then residential (Belgium), only if Immoweb refuses it. Set a proxy to start there instead.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}