{ "openapi": "3.0.1", "info": { "title": "Realtor Scraper โ€” US Real Estate Listings & Property Data", "description": "Scrape US real estate from realtor.com โ€” for-sale, for-rent & recently-sold listings with price & tax history, schools, flood risk, value estimates (AVM), mortgage breakdown, agent contacts, photos, GPS, full filters, radius search, and incremental NEW/UPDATED/EXPIRED tracking.", "version": "0.1", "x-build-id": "rVDvxvfaviuigO5pt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~realtor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-realtor-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/blackfalcondata~realtor-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-realtor-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/blackfalcondata~realtor-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-realtor-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": { "searchMode": { "title": "๐Ÿ” Search Mode", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Which listings to scrape.", "default": "for_sale" }, "searchLocations": { "title": "๐Ÿ“ Locations", "type": "array", "description": "One or more locations: \"City, ST\" (e.g. \"Austin, TX\"), a ZIP code (e.g. \"78704\"), or a neighborhood. Each is searched independently. Leave empty if you only use Start URLs.", "items": { "type": "string" } }, "propertyTypes": { "title": "๐Ÿ  Property Types", "type": "array", "description": "Restrict to one or more property types. Leave empty for all types.", "items": { "type": "string", "enum": [ "single_family", "condo", "townhomes", "multi_family", "duplex_triplex", "mobile", "land", "farm" ], "enumTitles": [ "Single family", "Condo", "Townhome", "Multi-family", "Duplex/Triplex", "Mobile", "Land", "Farm" ] }, "default": [] }, "searchStatuses": { "title": "๐Ÿท๏ธ Extra Statuses (for-sale only)", "type": "array", "description": "Include additional statuses alongside active for-sale listings.", "items": { "type": "string", "enum": [ "pending", "contingent", "coming_soon" ], "enumTitles": [ "Pending", "Contingent", "Coming soon" ] } }, "keyword": { "title": "๐Ÿ”ค Keyword", "type": "string", "description": "Optional text that must appear in the listing (e.g. \"pool\", \"waterfront\")." }, "startUrls": { "title": "๐Ÿ”— Start URLs", "type": "array", "description": "Paste realtor.com search-result URLs (e.g. https://www.realtor.com/realestateandhomes-search/Austin_TX) or individual property URLs. Search URLs read their location + mode from the URL; the filters below still apply.", "items": { "type": "string" } }, "maxResults": { "title": "๐Ÿ’ฏ Max Results", "minimum": 0, "type": "integer", "description": "Maximum listings to return (0 = full coverage). Full coverage works even for very large markets.", "default": 100 }, "mode": { "title": "โš™๏ธ Scrape Mode", "enum": [ "listings", "agents" ], "type": "string", "description": "Listings (default) or Agents โ€” scrape the real-estate agent directory (name, broker, office, ratings, sales stats) for a location.", "default": "listings" }, "agentLocations": { "title": "๐Ÿ“ Agent Locations", "type": "array", "description": "Agents mode only: locations to find agents in โ€” \"City, ST\" (e.g. \"Austin, TX\") or a ZIP code. Each is searched independently.", "items": { "type": "string" } }, "agentType": { "title": "๐Ÿค Agent Type", "enum": [ "BUYER", "SELLER" ], "type": "string", "description": "Agents mode: which side the agent represents.", "default": "BUYER" }, "agentLanguages": { "title": "๐Ÿ—ฃ๏ธ Agent Languages", "type": "array", "description": "Agents mode: filter by spoken language (e.g. \"spanish\").", "items": { "type": "string" } }, "enrichAgentContacts": { "title": "๐Ÿ“‡ Enrich Agent Contacts", "type": "boolean", "description": "Agents mode: fetch each agent's full contact profile โ€” direct & office phone, website, office address, license number, and social media. On by default.", "default": true }, "priceMin": { "title": "๐Ÿ’ฐ Min Price (USD)", "minimum": 0, "type": "integer", "description": "Minimum listing price." }, "priceMax": { "title": "๐Ÿ’ฐ Max Price (USD)", "minimum": 0, "type": "integer", "description": "Maximum listing price." }, "bedsMin": { "title": "๐Ÿ›๏ธ Min Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "bedsMax": { "title": "๐Ÿ›๏ธ Max Bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "bathsMin": { "title": "๐Ÿ› Min Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "sqftMin": { "title": "๐Ÿ“ Min Sqft", "minimum": 0, "type": "integer", "description": "Minimum interior square footage." }, "sqftMax": { "title": "๐Ÿ“ Max Sqft", "minimum": 0, "type": "integer", "description": "Maximum interior square footage." }, "centerLat": { "title": "๐Ÿงญ Center Latitude", "type": "string", "description": "Optional radius filter โ€” center latitude (decimal, e.g. 30.2672). Combine with Center Longitude + Radius to keep only listings within the radius." }, "centerLng": { "title": "๐Ÿงญ Center Longitude", "type": "string", "description": "Radius filter โ€” center longitude (decimal, e.g. -97.7431)." }, "radiusKm": { "title": "๐Ÿ“ Radius (km)", "minimum": 0, "type": "integer", "description": "Keep only listings within this many kilometres of the center point." }, "includeDetails": { "title": "๐Ÿ“‹ Include Detail Enrichment", "type": "boolean", "description": "Fetch each listing's full detail: price history, tax history, schools, flood risk, value estimates (AVM), mortgage breakdown, and full description. On by default. Turn off for faster, cheaper search-only records.", "default": true }, "enrichEmails": { "title": "๐Ÿ“ง Discover Contact Emails", "type": "boolean", "description": "Best-effort agent/advertiser email discovery (billed per listing with a match).", "default": false }, "descriptionMaxLength": { "title": "โœ‚๏ธ Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate description to this many characters. 0 = no truncation.", "default": 0 }, "descriptionFormat": { "title": "๐Ÿ“ Description Format", "enum": [ "text", "html", "markdown" ], "type": "string", "description": "Keep one description representation and drop the others to shrink payload.", "default": "text" }, "excludeEmptyFields": { "title": "๐Ÿงน Exclude Empty Fields", "type": "boolean", "description": "Drop null / empty-string / empty-array fields from each record.", "default": false }, "compact": { "title": "๐Ÿ“ฆ Compact Output", "type": "boolean", "description": "Output only core comparison fields (for AI-agent / MCP workflows).", "default": false }, "incrementalMode": { "title": "โ™ป๏ธ Incremental Mode", "type": "boolean", "description": "Track new/changed/expired listings across runs. Requires a State Key.", "default": false }, "stateKey": { "title": "๐Ÿ”‘ State Key", "type": "string", "description": "Stable identifier for this tracking universe (e.g. \"austin-tx-for-sale\")." }, "emitUnchanged": { "title": "โ™ป๏ธ Emit Unchanged Records", "type": "boolean", "description": "When incremental, also emit listings that have not changed.", "default": false }, "emitExpired": { "title": "โšฐ๏ธ Emit Expired Records", "type": "boolean", "description": "When incremental, also emit listings no longer found (now off-market). These off-market markers are always included so change tracking stays complete โ€” they are not subject to Max Results.", "default": false }, "skipReposts": { "title": "๐Ÿšซ Skip Reposts", "type": "boolean", "description": "When incremental, skip listings that are reposts of previously seen (now expired) listings.", "default": false }, "telegramToken": { "title": "๐Ÿ”‘ Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "๐Ÿ’ฌ Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID where alerts are sent." }, "discordWebhookUrl": { "title": "๐ŸŽฎ Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL." }, "slackWebhookUrl": { "title": "๐Ÿ’ผ Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL." }, "whatsappPhoneNumberId": { "title": "๐Ÿ“ฑ WhatsApp Phone Number ID", "type": "string", "description": "WhatsApp Business phone number ID from Meta Business Manager." }, "whatsappAccessToken": { "title": "๐Ÿ” WhatsApp Access Token", "type": "string", "description": "Meta Cloud API access token with whatsapp_business_messaging scope." }, "whatsappTo": { "title": "๐Ÿ“จ WhatsApp Recipient", "type": "string", "description": "Recipient phone number in E.164 format (e.g. +14155551234)." }, "webhookUrl": { "title": "๐Ÿช Generic Webhook URL", "type": "string", "description": "Universal escape hatch for n8n / Make / Zapier / custom HTTP backends. Receives a JSON POST per run." }, "webhookHeaders": { "title": "๐Ÿช Webhook Headers (optional)", "type": "object", "description": "Additional HTTP headers sent with the generic webhook POST." }, "notificationLimit": { "title": "๐Ÿ“Š Max Listings Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of listings included in each notification message (1โ€“20).", "default": 5 }, "notifyOnlyChanges": { "title": "๐Ÿ”„ Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only notify for NEW and UPDATED listings.", "default": false }, "appConnector": { "title": "๐Ÿ“ค Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings โ†’ API & Integrations to receive your results (including contact details where available). A run-summary is written to the connected app; support is best-effort as Apify expands its connector catalog." }, "mcpIssueTeam": { "title": "๐Ÿท๏ธ Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." } } }, "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 } } } } } } } } } }