{
  "openapi": "3.0.1",
  "info": {
    "title": "ChavesNaMão Scraper — Brazil Property Data & API",
    "description": "ChavesNaMão scraper & real estate data API for one of Brazil's largest property marketplaces. Sale & rent listings nationwide: price, condo, IPTU, size, bedrooms, suites, garages, address, GPS, agent contact, amenities, photos — clean JSON/CSV. Fast overview or full detail. No API key needed.",
    "version": "1.0",
    "x-build-id": "pXYZusRhGKefkqNDe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~chavesnamao-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-chavesnamao-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/sian.agency~chavesnamao-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-chavesnamao-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/sian.agency~chavesnamao-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-chavesnamao-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": {
          "scrapeMode": {
            "title": "⚡ Scrape mode",
            "enum": [
              "overview",
              "detail"
            ],
            "type": "string",
            "description": "⚡ **OVERVIEW** — fast, cheap. Pulls the search-list fields straight from ChavesNaMão's embedded page data (price, type, size, bedrooms, baths, city, state, agent, photo).\n\n🔍 **DETAIL** — full fields per listing (GPS, ZIP/CEP, condo fee, IPTU, suites, garages, construction details, full amenity lists, agent CRECI & phone, descriptions, the complete photo gallery). Each detail record is enriched with the overview fields too, so you always get a complete row. Slower and priced higher per result.\n\n**TIP:** Start with Overview — upgrade to Detail only when you need GPS, ZIP, agent phone or the full feature list.",
            "default": "overview"
          },
          "searchMode": {
            "title": "🧭 Search by",
            "enum": [
              "byPlace",
              "bySearchUrl",
              "byListingUrl"
            ],
            "type": "string",
            "description": "🧭 How to tell the scraper what to fetch:\n\n- **By place** — type one or more ChavesNaMão location slugs (e.g. \"sp-sao-paulo\", \"rj-rio-de-janeiro\", \"pr-curitiba\"). Combine with the contract, property type, sort and filters below.\n- **By search URL** — paste a chavesnamao.com.br search-results URL; the location, contract, type and ordering are honored.\n- **By listing URL** — Detail mode only: paste full chavesnamao.com.br listing URLs to fetch specific properties.",
            "default": "byPlace"
          },
          "places": {
            "title": "📍 Places",
            "type": "array",
            "description": "📍 ChavesNaMão location slugs, e.g. \"sp-sao-paulo\", \"rj-rio-de-janeiro\", \"pr-curitiba\". Use the `<uf>-<cidade>` pattern, a bare state (\"sp\"), or \"brasil\". Used when **Search by = By place**.\n\n**TIP:** Open the location on chavesnamao.com.br and copy the slug from the URL (the part after the property type, e.g. `/imoveis-a-venda/sp-sao-paulo/`). Add several — each place is searched in turn until **Max results** is reached.",
            "default": [
              "sp-sao-paulo"
            ],
            "items": {
              "type": "string"
            }
          },
          "contract": {
            "title": "🏷️ Contract",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "🏷️ **Sale** (à venda) or **Rent** (para alugar). Applies to By place searches.",
            "default": "sale"
          },
          "typeSlug": {
            "title": "🏠 Property type slug (optional)",
            "type": "string",
            "description": "🏠 ChavesNaMão property-type slug used in the search path. Leave the default \"imoveis\" for all property types, or set e.g. \"apartamentos\", \"casas\", \"coberturas\", \"terrenos\".",
            "default": "imoveis"
          },
          "sort": {
            "title": "↕️ Sort order (optional)",
            "enum": [
              "",
              "relevance",
              "price_asc",
              "price_desc",
              "area_asc",
              "area_desc",
              "newest"
            ],
            "type": "string",
            "description": "↕️ Order the search results. Applies to By place searches (a `filtro=or:` token).",
            "default": ""
          },
          "searchUrls": {
            "title": "🔗 Search URLs",
            "type": "array",
            "description": "🔗 chavesnamao.com.br search-results URLs to scrape. Used when **Search by = By search URL**.\n\n**TIP:** Build any search on chavesnamao.com.br (pick the location, à venda/para alugar, property type, ordering), then copy the URL from the address bar.\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.",
            "items": {
              "type": "string"
            }
          },
          "listingUrls": {
            "title": "🆔 Listing URLs",
            "type": "array",
            "description": "🆔 **Detail mode only.** Full chavesnamao.com.br listing URLs (e.g. https://www.chavesnamao.com.br/imovel/.../id-42593585/).\n\n**NOTE:** ChavesNaMão detail URLs require the full SEO slug — paste the listing URL from a search result, not a bare numeric ID.\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "🔢 Max results",
            "minimum": 1,
            "type": "integer",
            "description": "🔢 Maximum listings to extract this run.\n\n- **FREE tier:** capped at 25 listings per run.\n- **PAID tier:** unlimited — set as high as you need.",
            "default": 100
          },
          "maxPages": {
            "title": "📄 Max pages per place",
            "minimum": 1,
            "type": "integer",
            "description": "📄 Maximum search pages to fetch per place (15 listings each). Caps very large By place runs.",
            "default": 20
          },
          "minPrice": {
            "title": "💵 Min price (R$)",
            "minimum": 0,
            "type": "integer",
            "description": "💵 Optional. Minimum price filter (By place mode)."
          },
          "maxPrice": {
            "title": "💵 Max price (R$)",
            "minimum": 0,
            "type": "integer",
            "description": "💵 Optional. Maximum price filter (By place mode)."
          },
          "minBedrooms": {
            "title": "🛏️ Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "🛏️ Optional. Minimum number of bedrooms (By place mode)."
          },
          "minGarages": {
            "title": "🚗 Min parking spaces",
            "minimum": 0,
            "type": "integer",
            "description": "🚗 Optional. Minimum number of parking spaces / garages (By place mode)."
          },
          "proxyCountry": {
            "title": "🌐 Proxy country (optional)",
            "enum": [
              "",
              "BR"
            ],
            "type": "string",
            "description": "🌐 Leave empty to run **direct** (no proxy — the default, fastest & cheapest). Set to \"BR\" to route through a Brazilian residential proxy, only needed to dodge an IP rate-limit on very large runs.",
            "default": ""
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}