{
  "openapi": "3.0.1",
  "info": {
    "title": "Imovirtual Portugal Rent & Sale Listing Scraper",
    "description": "Search Imovirtual.com for apartments, houses, land, garages and commercial properties to rent or buy across Portugal, filtered by city, price, area and room count, with agency details, images and location.",
    "version": "2.0",
    "x-build-id": "LNFor5LdH4n7klqTp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crawlyth-forge~imovirtual-portugal-rent-and-sale-listing-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crawlyth-forge-imovirtual-portugal-rent-and-sale-listing-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/crawlyth-forge~imovirtual-portugal-rent-and-sale-listing-scraper/runs": {
      "post": {
        "operationId": "runs-sync-crawlyth-forge-imovirtual-portugal-rent-and-sale-listing-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/crawlyth-forge~imovirtual-portugal-rent-and-sale-listing-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-crawlyth-forge-imovirtual-portugal-rent-and-sale-listing-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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "forRent",
              "forSale",
              "search",
              "byUrl"
            ],
            "type": "string",
            "description": "How to find listings. Browse rent or sale listings, search by keyword, or paste Imovirtual URLs.",
            "default": "forRent"
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "any",
              "apartment",
              "house",
              "land",
              "garage",
              "commercial",
              "office",
              "warehouse",
              "room",
              "development"
            ],
            "type": "string",
            "description": "Property category. Any type searches every category one by one.",
            "default": "apartment"
          },
          "transactionType": {
            "title": "Transaction type (keyword search)",
            "enum": [
              "rent",
              "sale"
            ],
            "type": "string",
            "description": "Rent or sale for mode=search. The For rent and For sale modes set this automatically.",
            "default": "rent"
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "City, district, council or parish. Examples: Lisboa, Porto, Faro, lisboa/sintra, lisboa/lisboa/benfica. Leave empty for all Portugal.",
            "default": "Lisboa"
          },
          "searchQuery": {
            "title": "Keyword",
            "type": "string",
            "description": "Optional words to find in listing descriptions, e.g. piscina, varanda, garagem. Also used by mode=search."
          },
          "minPrice": {
            "title": "Minimum price (EUR)",
            "minimum": 0,
            "maximum": 100000000,
            "type": "integer",
            "description": "Minimum monthly rent or total sale price in euros."
          },
          "maxPrice": {
            "title": "Maximum price (EUR)",
            "minimum": 0,
            "maximum": 100000000,
            "type": "integer",
            "description": "Maximum monthly rent or total sale price in euros."
          },
          "minArea": {
            "title": "Minimum area (m2)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Minimum usable floor area in square metres."
          },
          "maxArea": {
            "title": "Maximum area (m2)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Maximum usable floor area in square metres."
          },
          "rooms": {
            "title": "Typology",
            "uniqueItems": true,
            "type": "array",
            "description": "One or more Portuguese typologies: T0 is a studio, T3 has three bedrooms. Matches any selected value.",
            "items": {
              "type": "string",
              "enum": [
                "ONE",
                "TWO",
                "THREE",
                "FOUR",
                "FIVE",
                "SIX_OR_MORE"
              ],
              "enumTitles": [
                "T0",
                "T1",
                "T2",
                "T3",
                "T4",
                "T5+"
              ]
            },
            "default": []
          },
          "extras": {
            "title": "Features",
            "uniqueItems": true,
            "type": "array",
            "description": "Only return listings with any of these features.",
            "items": {
              "type": "string",
              "enum": [
                "IS_PRIVATE_OWNER",
                "LIFT",
                "GARAGE",
                "AIR_CONDITIONING",
                "BALCONY",
                "TERRACE",
                "HAS_PHOTOS",
                "INTERNET",
                "GARDEN",
                "CABLE_TELEVISION",
                "SEPARATE_KITCHEN"
              ],
              "enumTitles": [
                "Private owner",
                "Lift",
                "Garage",
                "Air conditioning",
                "Balcony",
                "Terrace",
                "Has photos",
                "Internet",
                "Garden",
                "Cable television",
                "Separate kitchen"
              ]
            },
            "default": []
          },
          "privateOwnerOnly": {
            "title": "Private owners only",
            "type": "boolean",
            "description": "Skip agency listings and keep only properties posted by private owners.",
            "default": false
          },
          "daysSinceCreated": {
            "title": "Listed within",
            "enum": [
              "any",
              "1",
              "3",
              "7"
            ],
            "type": "string",
            "description": "Only include listings first published within this period.",
            "default": "any"
          },
          "buildYearMin": {
            "title": "Built from year",
            "minimum": 1800,
            "maximum": 2100,
            "type": "integer",
            "description": "Minimum construction year."
          },
          "buildYearMax": {
            "title": "Built until year",
            "minimum": 1800,
            "maximum": 2100,
            "type": "integer",
            "description": "Maximum construction year."
          },
          "floorsNumberMin": {
            "title": "Building floors from",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Minimum number of floors in the building."
          },
          "floorsNumberMax": {
            "title": "Building floors until",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Maximum number of floors in the building."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "relevance",
              "newest",
              "oldest",
              "priceAsc",
              "priceDesc",
              "areaAsc",
              "areaDesc"
            ],
            "type": "string",
            "description": "Order of the results.",
            "default": "relevance"
          },
          "listingUrls": {
            "title": "Imovirtual URLs (mode=byUrl)",
            "type": "array",
            "description": "Search result or listing URLs. Search URLs are paginated; listing URLs produce one record each. Examples: https://www.imovirtual.com/pt/resultados/arrendar/apartamento/lisboa/lisboa and https://www.imovirtual.com/pt/anuncio/... .",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Fetch full listing details",
            "type": "boolean",
            "description": "Open each listing page for description, bathrooms, energy certificate, build year, amenities, GPS coordinates and agency details. Turn off for faster bulk runs.",
            "default": true
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Maximum number of listing records to save.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}