{
"openapi": "3.0.1",
"info": {
"title": "Chaves na Mão Scraper 💰$0.90/1K Brazil Real Estate + Phones",
"description": "Chaves na Mão scraper for Brazil property listings for sale, rent and new developments. Search a city, neighbourhood, street or coordinates, or paste URLs. Price, condo fee, IPTU, rooms, area, address, GPS, photos, amenities, plus agent phone, WhatsApp and CRECI. Past the 1,500 cap.",
"version": "0.0",
"x-build-id": "mlO3f5Zg5xueaDPcN"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/memo23~chaves-na-mao-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-memo23-chaves-na-mao-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/memo23~chaves-na-mao-scraper/runs": {
"post": {
"operationId": "runs-sync-memo23-chaves-na-mao-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/memo23~chaves-na-mao-scraper/run-sync": {
"post": {
"operationId": "run-sync-memo23-chaves-na-mao-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": "Places to search, one per line. A city (São Paulo, Campinas), a neighbourhood or zone with its city (Pinheiros, São Paulo, Zona Sul, Rio de Janeiro), a street (Avenida Paulista), a state code (SP) or Brasil for the whole country. When a name exists in several places, the one with the most listings is used; add the city or state after a comma to pick another. Leave empty (with no URLs or coordinates) to search all of Brazil.",
"items": {
"type": "string"
}
},
"placeType": {
"title": "Treat locations as",
"enum": [
"",
"state",
"city",
"zone",
"neighborhood",
"street"
],
"type": "string",
"description": "Optional. Forces how each location is matched, for names that are both a city and a neighbourhood (Pinheiros is a city in Espírito Santo and a neighbourhood of São Paulo). Leave on Any for the best match.",
"default": ""
},
"latitude": {
"title": "Latitude",
"type": "number",
"description": "Optional. With longitude, searches the city nearest to this point. Example: -23.5505 (São Paulo)."
},
"longitude": {
"title": "Longitude",
"type": "number",
"description": "Optional. Example: -46.6333 (São Paulo)."
},
"startUrls": {
"title": "Chaves na Mão URLs",
"type": "array",
"description": "Optional. Pages copied from chavesnamao.com.br, any mix.
🔍 Search: run a search on the website with any filters and copy the address bar, e.g. https://www.chavesnamao.com.br/apartamentos-para-alugar/sp-sao-paulo/pinheiros/. The URL's own filters are kept.
🏠 Listing: https://www.chavesnamao.com.br/imovel/.../id-43457908/
Each listing becomes one row.",
"items": {
"type": "string"
}
},
"dealType": {
"title": "Listing kind",
"enum": [
"sale",
"rent",
"any",
"new"
],
"type": "string",
"description": "Applies to Locations and coordinates. Pasted search URLs already say which. Sale and rent returns both in one search; New developments returns launches (lançamentos) on plan, under construction or ready to move in.",
"default": "sale"
},
"constructionStages": {
"title": "Construction stage (new developments)",
"type": "array",
"description": "With Listing kind = New developments. Leave empty for every stage.",
"items": {
"type": "string",
"enum": [
"on_plan",
"under_construction",
"ready"
],
"enumTitles": [
"On plan (na planta)",
"Under construction (em obras)",
"Ready to move in (pronto para morar)"
]
}
},
"propertyTypes": {
"title": "Property types",
"type": "array",
"description": "Leave empty for every type.",
"items": {
"type": "string",
"enum": [
"apartment",
"house",
"condo_house",
"studio",
"flat",
"loft",
"penthouse",
"country_house",
"land",
"condo_land",
"office",
"commercial_house",
"shop",
"warehouse",
"commercial_land",
"building",
"garage",
"farm"
],
"enumTitles": [
"Apartment (apartamento)",
"House or townhouse (casa / sobrado)",
"House in a gated condominium",
"Studio or kitnet",
"Flat (serviced apartment)",
"Loft",
"Penthouse (cobertura)",
"Country house (sítio / chácara)",
"Land or lot (terreno)",
"Land in a gated condominium",
"Office or commercial room (sala comercial)",
"Commercial house",
"Shop or retail space (ponto comercial)",
"Warehouse or depot (galpão)",
"Commercial land",
"Whole building (prédio)",
"Garage",
"Farm (fazenda)"
]
}
},
"minPrice": {
"title": "Minimum price (R$)",
"minimum": 0,
"type": "integer",
"description": "Asking price for sales, monthly rent for rentals. Example: 300000."
},
"maxPrice": {
"title": "Maximum price (R$)",
"minimum": 0,
"type": "integer",
"description": "Example: 900000."
},
"minArea": {
"title": "Minimum area (m²)",
"minimum": 0,
"type": "integer",
"description": "Example: 50."
},
"maxArea": {
"title": "Maximum area (m²)",
"minimum": 0,
"type": "integer",
"description": "Example: 120."
},
"minBedrooms": {
"title": "Bedrooms (at least)",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "Example: 2 keeps listings with 2 or more bedrooms."
},
"minBathrooms": {
"title": "Bathrooms (at least)",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "Example: 2."
},
"minParkingSpaces": {
"title": "Parking spaces (at least)",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "Example: 1."
},
"listedBy": {
"title": "Listed by",
"enum": [
"all",
"owner",
"agency"
],
"type": "string",
"description": "All advertisers, owners selling or renting directly (direto com o proprietário), or real estate agencies only. Not used for new developments.",
"default": "all"
},
"amenities": {
"title": "Must have",
"type": "array",
"description": "Keeps listings that advertise these features. Leave empty for no restriction.",
"items": {
"type": "string",
"enum": [
"pool",
"gym",
"barbecue",
"gourmet_area",
"playground",
"playroom",
"sports_court",
"party_room",
"games_room",
"sauna",
"air_conditioning",
"built_in_cabinets",
"elevator",
"balcony",
"hot_tub",
"fireplace",
"garden",
"backyard",
"furnished",
"service_area",
"attic",
"walk_in_closet",
"maid_room",
"outbuilding",
"home_office",
"laundry",
"guest_bathroom",
"doorman",
"guardhouse",
"intercom",
"security_cameras",
"security_patrol"
],
"enumTitles": [
"Pool",
"Gym",
"Barbecue",
"Gourmet area",
"Playground",
"Kids' playroom",
"Sports court",
"Party room",
"Games room",
"Sauna",
"Air conditioning",
"Built-in cabinets",
"Elevator",
"Balcony",
"Hot tub",
"Fireplace",
"Garden",
"Backyard",
"Furnished",
"Service area",
"Attic",
"Walk-in closet",
"Maid's room",
"Outbuilding (edícula)",
"Home office",
"Laundry",
"Guest bathroom (lavabo)",
"Doorman",
"Guardhouse",
"Intercom",
"Security cameras",
"Security patrol"
]
}
},
"nearby": {
"title": "Close to",
"type": "array",
"description": "Keeps listings the website marks as within about 1 km of these.",
"items": {
"type": "string",
"enum": [
"public_transport",
"parks",
"shopping"
],
"enumTitles": [
"Public transport (metro, train, bus)",
"Parks and squares",
"Shopping centre"
]
}
},
"petFriendly": {
"title": "Pets allowed",
"type": "boolean",
"description": "Only listings that accept pets.",
"default": false
},
"sortBy": {
"title": "Sort",
"enum": [
"relevance",
"newest",
"lowest_price",
"highest_price",
"smallest_area",
"largest_area"
],
"type": "string",
"description": "Order of results. Decides which listings you get when Max listings is lower than the search total.",
"default": "relevance"
},
"maxItems": {
"title": "Max listings",
"minimum": 0,
"type": "integer",
"description": "Maximum listings for the whole run, across all searches. Default 5,000. Set 0 for everything the searches match: large cities hold hundreds of thousands, and the actor splits a big search by price range so it is not stopped at the website's 1,500-result limit. Free Apify plans are capped at 100 listings and the first search per run.",
"default": 5000
},
"maxItemsPerSearch": {
"title": "Max listings per search",
"minimum": 0,
"type": "integer",
"description": "Optional. Caps each location, coordinate search or search URL on its own, so the first big place does not use up Max listings. Example: 500."
},
"includeAllPhotos": {
"title": "All photos",
"type": "boolean",
"description": "Search results carry each listing's first 5 photos. Turn on to get every photo (often 20-30). Slower, no extra charge.",
"default": false
},
"includeRawData": {
"title": "Include the original listing record",
"type": "boolean",
"description": "Adds a raw field with the listing exactly as the website returns it, for fields this actor does not map. Makes rows larger.",
"default": false
},
"saveAdvertisers": {
"title": "Advertiser list",
"type": "boolean",
"description": "Saves one record per agency, broker or owner in the results (contacts, CRECI, Google rating, listings for sale and rent, price range, cities, neighbourhoods) to the run's key-value store as ADVERTISERS (JSON) and ADVERTISERS.csv. Not charged.",
"default": true
},
"trackChangesProject": {
"title": "Change-tracking project",
"type": "string",
"description": "Optional. Any name, e.g. sp-rentals-daily. Each run with the same name marks every row new, changed (price, fees, title, size, photos or stage) or unchanged against the earlier runs, and adds previousPrice and firstSeenAt. Use one name per scheduled search."
},
"onlyNewOrChanged": {
"title": "Only new or changed listings",
"type": "boolean",
"description": "With a change-tracking project: leave unchanged listings out of the dataset. You are not charged for them.",
"default": false
},
"includeRemoved": {
"title": "Report removed listings",
"type": "boolean",
"description": "With a change-tracking project: when a search is read to the end, listings from earlier runs that Chaves na Mão no longer has come back once as rows with changeType: \"removed\", their last price and the last day they were seen. Listings still online but no longer matching the search are not reported.",
"default": true
},
"maxConcurrency": {
"title": "Parallel requests",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "Result pages read at the same time. Default 4.",
"default": 4
},
"proxy": {
"title": "Proxy configuration (optional)",
"type": "object",
"description": "Leave empty: the default works out of the box. To use your own proxies, add their URLs here. Apify Proxy is not used by this actor."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}