{ "openapi": "3.0.1", "info": { "title": "Chaves na Mão Property Scraper - Brazil Real Estate Listings", "description": "Scrapes property listings for sale and rent from Chaves na Mão (chavesnamao.com.br): price, condo fee, IPTU, area, bedrooms, address, GPS, photos, amenities, description and agent name, CRECI, phone and WhatsApp. Search by location and filters, search URL or property URL.", "version": "1.0", "x-build-id": "87hpiFCwWVLgg2h7W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~chavesnamao-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-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/confidential_gnat~chavesnamao-property-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-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/confidential_gnat~chavesnamao-property-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-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": { "startUrls": { "title": "Search or property URLs", "type": "array", "description": "Chaves na Mão search pages with any filters (for example https://www.chavesnamao.com.br/apartamentos-para-alugar/rj-rio-de-janeiro/copacabana/) or single property pages (for example https://www.chavesnamao.com.br/imovel/apartamento-a-venda-2-quartos-sp-sao-paulo-bela-vista-97m2-RS750000/id-46792572/).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items per search", "minimum": 1, "type": "integer", "description": "Maximum unique listings saved for each location or search URL. The site shows at most 99 pages (about 1,485 listings) per search; split large searches by neighborhood or price to get more.", "default": 5 }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Use the same name on each scheduled run to get only new listings. Listings already scraped under this name are skipped and not charged, and they do not count towards Max items. Each record gets changeType: new." }, "scrapeDetails": { "title": "Get all photos", "type": "boolean", "description": "Open every listing to get the full photo gallery. Search results already include every other field and the first 5 photos, so leave this off for faster, cheaper runs. Property URLs always include all photos.", "default": false }, "locations": { "title": "Locations", "type": "array", "description": "Cities, neighborhoods or streets to search, for example São Paulo, Copacabana or Belo Horizonte. Each location is searched separately with the filters below. You can also enter a site slug such as sp-sao-paulo or rj-rio-de-janeiro/copacabana.", "default": [], "items": { "type": "string" } }, "transaction": { "title": "Buy or rent", "enum": [ "venda", "alugar" ], "type": "string", "description": "Listings for sale or for rent. Applies to location searches.", "default": "venda" }, "propertyType": { "title": "Property type", "enum": [ "imoveis", "imoveis-residenciais", "imoveis-comerciais", "apartamentos", "casas", "casas-em-condominio", "coberturas", "flat", "kitnet", "loft", "terrenos", "terrenos-em-condominio", "terreno-comercial", "chacaras", "fazendas", "sala-comercial", "casa-comercial", "ponto-comercial", "galpao", "predio", "garagem" ], "type": "string", "description": "Type of property. Applies to location searches.", "default": "imoveis" }, "minPrice": { "title": "Minimum price (R$)", "minimum": 0, "type": "integer", "description": "Lowest sale price or monthly rent in Brazilian reais. Applies to location searches." }, "maxPrice": { "title": "Maximum price (R$)", "minimum": 0, "type": "integer", "description": "Highest sale price or monthly rent in Brazilian reais. Applies to location searches." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 1, "maximum": 4, "type": "integer", "description": "Only listings with at least this many bedrooms (1 to 4). Applies to location searches." }, "sortBy": { "title": "Sort by", "enum": [ "default", "newest", "priceAsc", "priceDesc", "areaAsc", "areaDesc" ], "type": "string", "description": "Order of the results. Applies to location searches.", "default": "default" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "This website works without a proxy. Enable Apify Proxy only if you get blocked.", "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 } } } } } } } } } }