{
  "openapi": "3.0.1",
  "info": {
    "title": "ZAP Imóveis & VivaReal Scraper – Brazil Property Listings",
    "description": "Scrape Brazilian property listings for sale or rent from ZAP Imóveis and VivaReal in one run, de-duplicated by listing ID. Price, condo fee, IPTU, area, rooms, address, coordinates, amenities, photos, agency. No login, no browser. Unofficial. JSON/CSV/API.",
    "version": "0.1",
    "x-build-id": "HM5lEfDN09tccEl6j"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kyungminlee~zap-vivareal-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kyungminlee-zap-vivareal-property-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/kyungminlee~zap-vivareal-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kyungminlee-zap-vivareal-property-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/kyungminlee~zap-vivareal-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kyungminlee-zap-vivareal-property-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": {
          "site": {
            "title": "Portal",
            "enum": [
              "both",
              "zap",
              "vivareal"
            ],
            "type": "string",
            "description": "Which portal(s) to search. With both, pages from ZAP Imóveis and VivaReal are read alternately and a listing that appears on both (same listing ID) is saved once.",
            "default": "both"
          },
          "transaction": {
            "title": "Sale or rent",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Listings for sale (`venda`) or for rent (`aluguel`).",
            "default": "sale"
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "One place per line as `state/city`, `state/city/neighborhood` or `state/city/zone/neighborhood`, using the slugs from the portals' URLs (accents and capitals are converted for you). Examples: `sp/sao-paulo`, `rj/rio-de-janeiro/zona-sul/copacabana`, `sp/sao-paulo/zona-sul/moema`, `pr/curitiba/batel`, `mg/belo-horizonte`, or just `sc` for a whole state. The state is the two-letter UF (`sp`, `rj`, `mg`...). If you leave out the zone of a São Paulo or Rio neighborhood, the Actor tries the usual zones for you. Each location is one search.",
            "items": {
              "type": "string"
            }
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "all",
              "apartment",
              "house",
              "condo-house",
              "townhouse",
              "penthouse",
              "flat",
              "kitnet",
              "studio",
              "loft",
              "village-house",
              "land",
              "farm",
              "office",
              "store",
              "warehouse",
              "building",
              "garage",
              "corporate-floor",
              "hotel"
            ],
            "type": "string",
            "description": "The property type, as the portals' own path category. Types marked \"ZAP only\" have no VivaReal page and are searched on ZAP Imóveis only.",
            "default": "apartment"
          },
          "maxListings": {
            "title": "Maximum listings per location",
            "minimum": 1,
            "maximum": 3000,
            "type": "integer",
            "description": "How many listings to save per location (or per start URL), both portals combined, counted after filters and de-duplication. The portals show at most 50 pages (1,500 listings) per search, so for more, split a city into neighborhoods or property types. The run's maximum charge can lower this.",
            "default": 100
          },
          "minPrice": {
            "title": "Minimum price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings whose price is at least this amount: the sale price for sale searches, the monthly rent for rent searches."
          },
          "maxPrice": {
            "title": "Maximum price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings whose price (sale price, or monthly rent for rent searches) is at most this amount."
          },
          "minBedrooms": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings with at least this many bedrooms (quartos)."
          },
          "maxBedrooms": {
            "title": "Maximum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings with at most this many bedrooms (quartos)."
          },
          "minArea": {
            "title": "Minimum usable area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings with at least this usable area in square meters."
          },
          "maxArea": {
            "title": "Maximum usable area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings with at most this usable area in square meters."
          },
          "includeDetails": {
            "title": "Open each listing page (publication and update dates, full description)",
            "type": "boolean",
            "description": "Also open every saved listing's own page to add the publication date (`publishedAt`), last update (`updatedAt`) and the full description. This is one extra request per listing, so runs take about 30 times longer. Without it, those three fields are empty.",
            "default": false
          },
          "deduplicate": {
            "title": "De-duplicate by listing ID",
            "type": "boolean",
            "description": "Save each listing ID only once per run, even if it shows up on both portals or in several locations.",
            "default": true
          },
          "startUrls": {
            "title": "Search page URLs (advanced)",
            "type": "array",
            "description": "Optional ZAP Imóveis or VivaReal search result URLs, for example `https://www.zapimoveis.com.br/aluguel/apartamentos/rj+rio-de-janeiro+zona-sul+copacabana/` or `https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/2-quartos/`. Only the path is used: query parameters such as `onde=`, `tipos=` or `precoMaximo=` are removed because the portals' robots.txt disallows them for crawlers, and URLs whose path robots.txt disallows are skipped. Each URL is one search on its own portal.",
            "items": {
              "type": "string"
            }
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Off by default: in our tests the portals answered best without a proxy. If they block the run anyway (several 403/Cloudflare answers in a row), the Actor automatically switches to Apify Proxy (Brazilian residential if your plan includes it). If you turn a proxy on here, it is used from the first request, and the Actor switches to a direct connection if that proxy gets blocked repeatedly.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}