{
  "openapi": "3.0.1",
  "info": {
    "title": "ChavesNaMao City Property Listings Extractor",
    "description": "Search ChavesNaMão for sale or rental properties in 15 major Brazilian cities, with price, condominium fee, IPTU, room counts, area and neighborhood for each listing.",
    "version": "2.0",
    "x-build-id": "h8qsnYHHOCBNfp8bD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vexaloom-labs~chavesnamao-city-property-listings-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vexaloom-labs-chavesnamao-city-property-listings-extractor",
        "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/vexaloom-labs~chavesnamao-city-property-listings-extractor/runs": {
      "post": {
        "operationId": "runs-sync-vexaloom-labs-chavesnamao-city-property-listings-extractor",
        "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/vexaloom-labs~chavesnamao-city-property-listings-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-vexaloom-labs-chavesnamao-city-property-listings-extractor",
        "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": {
          "collectionMode": {
            "title": "What to collect",
            "enum": [
              "listings",
              "details"
            ],
            "type": "string",
            "description": "Search listings by city and filters, or fetch full details for specific ChavesNaMão listings.",
            "default": "listings"
          },
          "transactionType": {
            "title": "Sale or rent",
            "enum": [
              "sell",
              "rent"
            ],
            "type": "string",
            "description": "Whether to search properties for sale (venda) or for rent (aluguel).",
            "default": "sell"
          },
          "city": {
            "title": "City",
            "enum": [
              "sao-paulo",
              "rio-de-janeiro",
              "belo-horizonte",
              "porto-alegre",
              "curitiba",
              "brasilia",
              "salvador",
              "fortaleza",
              "recife",
              "campinas",
              "manaus",
              "belem",
              "goiania",
              "florianopolis",
              "vitoria",
              "praia-grande",
              "joao-pessoa"
            ],
            "type": "string",
            "description": "Brazilian city to search in listings mode. For any other city, paste one of its ChavesNaMão search URLs into Listing URLs.",
            "default": "sao-paulo"
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "all",
              "apartments",
              "houses",
              "gated-houses",
              "kitnets",
              "penthouses",
              "flats",
              "lofts",
              "commercial-rooms",
              "commercial-houses",
              "commercial-points",
              "buildings",
              "warehouses",
              "land",
              "gated-land",
              "commercial-land",
              "farms",
              "rural-farms",
              "garages"
            ],
            "type": "string",
            "description": "Restrict the search to one property type, or search every type.",
            "default": "all"
          },
          "bedroomsMin": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of bedrooms (quartos). Use 0 for no minimum.",
            "default": 0
          },
          "bathroomsMin": {
            "title": "Minimum bathrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of bathrooms (banheiros). Use 0 for no minimum.",
            "default": 0
          },
          "garagesMin": {
            "title": "Minimum parking spaces",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of garage or parking spaces (vagas). Use 0 for no minimum.",
            "default": 0
          },
          "priceMin": {
            "title": "Minimum price (BRL)",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Minimum asking price in Brazilian reais. Leave empty for no minimum."
          },
          "priceMax": {
            "title": "Maximum price (BRL)",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Maximum asking price in Brazilian reais. Leave empty for no maximum."
          },
          "areaMin": {
            "title": "Minimum area (m²)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Minimum usable area in square metres. Leave empty for no minimum."
          },
          "areaMax": {
            "title": "Maximum area (m²)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Maximum usable area in square metres. Leave empty for no maximum."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "relevance",
              "newest",
              "priceAsc",
              "priceDesc",
              "areaAsc",
              "areaDesc"
            ],
            "type": "string",
            "description": "Order of the listing results.",
            "default": "relevance"
          },
          "ownerType": {
            "title": "Advertiser",
            "enum": [
              "all",
              "owner",
              "agency"
            ],
            "type": "string",
            "description": "Show every advertiser, only listings direct from the owner, or only real-estate agencies.",
            "default": "all"
          },
          "maxItems": {
            "title": "Maximum listings",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum number of listings to save across all selected searches (1–1000).",
            "default": 20
          },
          "maxPages": {
            "title": "Maximum pages per search",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum result pages to request for each search (30 listings per page). Stops earlier when the source runs out.",
            "default": 34
          },
          "includeDetails": {
            "title": "Fetch full details",
            "type": "boolean",
            "description": "Fetch each listing's detail page data: full description, publisher phone and CRECI, photo list, amenities, video and tour links, created and updated dates. Costs one extra request per listing.",
            "default": false
          },
          "listingUrls": {
            "title": "Listing URLs",
            "type": "array",
            "description": "Optional ChavesNaMão search URLs to scrape exactly as configured on the site. Use this for cities, neighbourhoods or filter combinations not covered by the controls above.",
            "items": {
              "type": "string"
            }
          },
          "propertyUrls": {
            "title": "Property detail URLs",
            "type": "array",
            "description": "ChavesNaMão property URLs to fetch in details mode (they contain an id-<number> segment).",
            "items": {
              "type": "string"
            }
          },
          "propertyIds": {
            "title": "Property IDs",
            "type": "array",
            "description": "ChavesNaMão listing IDs to fetch in details mode. Property URLs also work.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}