{ "openapi": "3.0.1", "info": { "title": "Chaves na Mão Scraper - Brazil Real Estate Listings", "description": "Scrape Chaves na Mão listings at chavesnamao.com.br across Brazil for sale or rent. Filter by location, coordinates, price, area, property type, amenities, advertiser, and nearby places, then export clean results to JSON, CSV, or Excel for market research, pricing, and lead generation.", "version": "0.0", "x-build-id": "WOjJ0yl8CuxbOF1RK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igolaizola~chavesnamao-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igolaizola-chavesnamao-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/igolaizola~chavesnamao-scraper/runs": { "post": { "operationId": "runs-sync-igolaizola-chavesnamao-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/igolaizola~chavesnamao-scraper/run-sync": { "post": { "operationId": "run-sync-igolaizola-chavesnamao-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", "required": [ "maxItems", "operation" ], "properties": { "maxItems": { "title": "Maximum listings", "minimum": 0, "type": "integer", "description": "Maximum number of property listings to collect. Set to 0 to request all available listings, subject to actor result limits.", "default": 100 }, "fetchDetails": { "title": "Fetch listing details", "type": "boolean", "description": "Fetch the full structured details page for each collected listing and add it under the _details field. This uses one additional request per listing and may increase run time and cost.", "default": false }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Choose whether to collect properties for sale or rent.", "default": "sale" }, "location": { "title": "Location", "type": "string", "description": "Optional city, zone, neighborhood, or street to search. Example: São Paulo. When omitted, the actor searches across Brazil. When provided, it selects the closest matching area and keeps the other search URL filters.", "default": "" }, "locationType": { "title": "Location type", "enum": [ "", "city", "zone", "neighborhood", "street" ], "type": "string", "description": "Optional category used to narrow location matches. Leave empty to let the actor choose the best category.", "default": "" }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Only include listings priced at or above this amount in Brazilian reais. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Only include listings priced at or below this amount in Brazilian reais. Leave empty for no maximum." }, "minArea": { "title": "Minimum area (m²)", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many square metres of area." }, "maxArea": { "title": "Maximum area (m²)", "minimum": 0, "type": "integer", "description": "Only include listings with at most this many square metres of area." }, "bedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bedrooms." }, "bathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bathrooms." }, "garages": { "title": "Minimum parking spaces", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many parking spaces." }, "amenities": { "title": "Amenities", "uniqueItems": true, "type": "array", "description": "Only include listings with the selected amenities.", "items": { "type": "string", "enum": [ "air-conditioning", "service-area", "built-in-cabinets", "attic", "playroom", "barbecue", "security-circuit", "walk-in-closet", "maid-room", "outbuilding", "elevator", "office", "gourmet-area", "guardhouse", "hot-tub", "intercom", "garden", "fireplace", "guest-bathroom", "laundry", "furnished", "pool", "playground", "doorman", "backyard", "party-room", "games-room", "sauna", "balcony" ], "enumTitles": [ "Air conditioning", "Service area", "Built-in cabinets", "Attic", "Playroom", "Barbecue", "Security circuit", "Walk-in closet", "Maid's room", "Outbuilding", "Elevator", "Office", "Gourmet area", "Guardhouse", "Hot tub", "Intercom", "Garden", "Fireplace", "Guest bathroom", "Laundry", "Furnished", "Pool", "Playground", "Doorman", "Backyard", "Party room", "Games room", "Sauna", "Balcony" ] }, "default": [] }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "Only include the selected property types.", "items": { "type": "string", "enum": [ "apartment", "house", "condominium", "farm", "building", "commercial-room", "farmland", "flat", "garage", "loft", "commercial-point", "studio", "land", "coverage", "commercial-house", "condominium-land", "commercial-land", "warehouse" ], "enumTitles": [ "Apartment", "House or townhouse", "House in a condominium", "Farm or country house", "Building", "Commercial room", "Farmland", "Flat", "Garage", "Loft", "Commercial point", "Studio or kitnet", "Land or lot", "Penthouse", "Commercial house", "Condominium land", "Commercial land", "Warehouse or depot" ] }, "default": [] }, "launchOnly": { "title": "New developments only", "type": "boolean", "description": "Only include properties in developments that are under construction, planned, or ready to move into.", "default": false }, "nearbyPlaces": { "title": "Nearby places", "uniqueItems": true, "type": "array", "description": "Only include listings near the selected place categories. The platform uses a fixed distance of up to 1 km.", "items": { "type": "string", "enum": [ "subway", "parks", "shopping" ], "enumTitles": [ "Metro or train station", "Parks or squares", "Shopping center" ] }, "default": [] }, "advertiser": { "title": "Advertiser", "enum": [ "all", "owner", "agency" ], "type": "string", "description": "Choose whether to include all advertisers, only property owners, or only real-estate agencies.", "default": "all" }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Latitude used to resolve the nearest city. Provide together with longitude; coordinates take precedence over location text. Example: -23.55052 for São Paulo." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Longitude used to resolve the nearest city. Provide together with latitude; coordinates take precedence over location text. Example: -46.633309 for São Paulo." } } }, "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 } } } } } } } } } }