{ "openapi": "3.0.1", "info": { "title": "MGF Imoveis Scraper - Brazil Property Listings & Prices", "description": "Scrape MGF Imoveis, now deztop.com, Brazil's national property portal: sale, rent and holiday listings with BRL prices, areas, rooms, address, photos, agency profiles, market snapshots and price-change monitoring. No login. Export CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "lz4ZUUebp2KdVzqGs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/recordsdata~mgfimoveis-br-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-recordsdata-mgfimoveis-br-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/recordsdata~mgfimoveis-br-scraper/runs": { "post": { "operationId": "runs-sync-recordsdata-mgfimoveis-br-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/recordsdata~mgfimoveis-br-scraper/run-sync": { "post": { "operationId": "run-sync-recordsdata-mgfimoveis-br-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": { "recordTypes": { "title": "What to collect", "type": "array", "description": "listings = property ads with BRL price, areas, rooms and address (add the detail fetch below for the full description, up to 50 photos and the advertiser). agencies = one profile per real estate business found behind the ads, with its listing count and market statistics. snapshots = one market-statistics row per search (listing count, price median, price per m2, top cities).", "items": { "type": "string", "enum": [ "listings", "agencies", "snapshots" ], "enumTitles": [ "Property listings", "Agency profiles", "Market snapshots" ] }, "default": [ "listings" ] }, "maxItems": { "title": "Max items (free plan: 10)", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stops after this many rows (all record types together). Free plans are limited to 10 items per run. Leave empty for 50.", "default": 50 }, "operations": { "title": "Deal type", "type": "array", "description": "sale = properties for sale, rent = long-term rentals (price per month), season = holiday rentals (price per day). One search is made per deal type. Leave empty for sale.", "items": { "type": "string", "enum": [ "sale", "rent", "season" ], "enumTitles": [ "For sale", "For rent", "Season (holiday) rental" ] }, "default": [] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Limits the search to these kinds of property. Leave empty for all types.", "items": { "type": "string", "enum": [ "launch", "apartment", "penthouse", "house", "condo-house", "farmlet", "parking", "farm", "studio", "warehouse", "kitnet", "store", "inn", "room", "commercial-room", "land" ], "enumTitles": [ "New development (launch)", "Apartment", "Penthouse", "House", "House in a condominium", "Small farm (chacara)", "Parking space", "Farm or ranch (fazenda, sitio)", "Flat / studio", "Warehouse / shed", "Kitnet", "Store", "Inn / chalet", "Room", "Commercial room", "Land / lot" ] }, "default": [] }, "locations": { "title": "Places (e.g. sp/campinas)", "type": "array", "description": "Where to search, one per line: a state code (sp), a city path (sp/campinas), a neighbourhood path (sp/campinas/cambui) or text such as \"Campinas, SP\" or \"Cambui, Campinas - SP\". The site only knows places it has listings for; an unknown place gives a free error row. Leave empty for all of Brazil.", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "newest", "relevance", "price-asc", "price-desc" ], "type": "string", "description": "newest is stable and repeatable. relevance is the site default and reshuffles between requests. Price sorts order within each price band.", "default": "newest" }, "startUrls": { "title": "Site addresses", "type": "array", "description": "deztop.com search pages (/br/imoveis/sp/campinas/venda/apartamento?pricemax=500000), listing pages (/br/imovel/) and advertiser pages (/br/pro/). Old mgfimoveis.com.br search and listing addresses work too. Filters you set below do not change an address you paste.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "Listing numbers (e.g. 312862341)", "type": "array", "description": "Single listings by number (the listingId of a row), one per line, for example 312862341. Each one is read in full. A number the site no longer has produces a free error row.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price (BRL)", "minimum": 0, "type": "integer", "description": "Lowest price in reais (per month for rent, per day for season)." }, "maxPrice": { "title": "Max price (BRL)", "minimum": 0, "type": "integer", "description": "Highest price in reais (per month for rent, per day for season)." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 9, "type": "integer", "description": "At least this many bedrooms." }, "minSuites": { "title": "Min suites", "minimum": 0, "maximum": 9, "type": "integer", "description": "At least this many suites." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 9, "type": "integer", "description": "At least this many bathrooms." }, "minParking": { "title": "Min parking spaces", "minimum": 0, "maximum": 9, "type": "integer", "description": "At least this many parking spaces." }, "minArea": { "title": "Min area (m2)", "minimum": 0, "type": "integer", "description": "Smallest total area in square metres." }, "maxArea": { "title": "Max area (m2)", "minimum": 0, "type": "integer", "description": "Largest total area in square metres." }, "maxCondoFee": { "title": "Max condominium fee (BRL per month)", "minimum": 0, "type": "integer", "description": "Highest monthly condominium fee in reais." }, "maxIptu": { "title": "Max IPTU (BRL)", "minimum": 0, "type": "integer", "description": "Highest property tax (IPTU) in reais." }, "directOwnerOnly": { "title": "Direct owner only", "type": "boolean", "description": "Only listings published by the owner, without an agency.", "default": false }, "furnishedOnly": { "title": "Furnished only", "type": "boolean", "description": "Only furnished properties.", "default": false }, "newOnly": { "title": "New properties only", "type": "boolean", "description": "Only properties flagged as new.", "default": false }, "auctionOnly": { "title": "Auctions only", "type": "boolean", "description": "Only properties flagged as auction or foreclosure.", "default": false }, "features": { "title": "Must-have features", "type": "array", "description": "Only properties that have all of these features.", "items": { "type": "string", "enum": [ "air-conditioning", "service-area", "barbecue-grill", "closet", "fireplace", "pool", "balcony", "lake-view", "sea-view", "elevator", "accepts-financing", "pets-allowed", "doorman-24h", "playground", "party-room", "open-view", "morning-sun", "gourmet-balcony" ], "enumTitles": [ "Air conditioning", "Service area", "Barbecue grill", "Closet", "Fireplace", "Pool", "Balcony", "Lake view", "Sea view", "Elevator", "Accepts financing", "Pets allowed", "24h doorman", "Playground", "Party room", "Open view", "Morning sun", "Gourmet balcony" ] }, "default": [] }, "rentGuarantees": { "title": "Accepted rent guarantees (rent only)", "type": "array", "description": "Rent searches only: properties that accept these guarantees.", "items": { "type": "string", "enum": [ "deposit", "guarantor", "insurance-bond", "letter-of-guarantee", "capitalization-bonds" ], "enumTitles": [ "Deposit", "Guarantor", "Rent insurance bond", "Bank letter of guarantee", "Capitalization bond" ] }, "default": [] }, "fetchDetails": { "title": "Fetch full listing pages", "type": "boolean", "description": "On: one extra request per listing for the full description, up to 50 photos, amenities, condominium fee, IPTU, floor, building age, update time and the advertiser (billed as a listing detail record). Off: the search-card fields only (billed as a listing record).", "default": false }, "includeContactDetails": { "title": "Include business contacts", "type": "boolean", "description": "Adds phones and emails written in the description of a listing published by a real estate business. Private owners are never included, whatever this setting. Turn on only if you have a lawful reason to process contact data.", "default": false }, "includeRaw": { "title": "Include raw payload", "type": "boolean", "description": "Adds a raw field with the unmapped structured data of the listing page (JSON-LD offer details). Seller contact data is never included.", "default": false }, "onlyNew": { "title": "Only new records (for scheduled runs)", "type": "boolean", "description": "Skips records delivered by an earlier run of the same search. Nothing skipped is charged.", "default": false }, "trackPriceChanges": { "title": "Report price changes", "type": "boolean", "description": "With only new records on, listings seen before are delivered again when their price changed, as a price-change row with the previous price, the difference and the percentage. Turns on Only new records.", "default": false }, "stateKey": { "title": "Monitor name (optional)", "type": "string", "description": "Optional label to keep several monitors with identical settings apart.", "default": "" }, "resetSeen": { "title": "Forget what was delivered", "type": "boolean", "description": "Clears the memory of this search before the run, so everything counts as new.", "default": false }, "splitLargeSearches": { "title": "Split large searches into price bands", "type": "boolean", "description": "The site answers at most 100 pages (3,100 listings) per search. On: a bigger search is cut into price bands so every listing can be read. Off: only the first 3,100 are read.", "default": true }, "maxPagesPerSearch": { "title": "Max pages per search (31 listings each)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Pages of 31 listings read per search or price band. The site never answers more than 100.", "default": 100 }, "snapshotSamplePages": { "title": "Market snapshot depth (pages)", "minimum": 1, "maximum": 5, "type": "integer", "description": "Market snapshots compute price statistics from this many pages (31 listings each) of the search.", "default": 2 }, "maxConcurrency": { "title": "Parallel requests (1 to 6)", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many listing pages are fetched at once. Requests still start at least 250 ms apart.", "default": 3 }, "requestDelayMs": { "title": "Pause between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum time between two requests to the site. The Actor never goes below 250 ms, whatever is set here.", "default": 250 }, "proxyConfiguration": { "title": "Proxy (only if requests fail)", "type": "object", "description": "Optional. Leave proxy off (the default): the site works without one. Turn it on only if requests start failing.", "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 } } } } } } } } } }