{ "openapi": "3.0.1", "info": { "title": "FSBO.com Scraper - For Sale By Owner Homes", "description": "Scrape for-sale-by-owner homes from fsbo.com by city, state or ZIP code. Each listing arrives with its asking price and full property facts such as beds and baths, lot size, HOA fee and photos. Monitor mode flags new and price-changed listings on every run.", "version": "0.2", "x-build-id": "QrWCyuBypDpBtdFax" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~fsbo-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-fsbo-com-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~fsbo-com-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-fsbo-com-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~fsbo-com-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-fsbo-com-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": { "query": { "title": "🔍 Search Term(s)", "type": "string", "description": "Keywords matched against the listing text, e.g. \"home\", \"waterfront\", \"acreage\", \"fixer upper\". Use a JSON array for several searches in one run. Required if no startUrls provided." }, "location": { "title": "📍 Location", "type": "string", "description": "Where to search: \"City, ST\" (e.g. \"Austin, TX\"), a state, or a 5-digit ZIP. Leave empty to search nationwide. Use a JSON array for several locations in one run." }, "states": { "title": "🗺️ States", "type": "array", "description": "Two-letter US state codes (e.g. TX, FL), or ALL for nationwide. Each state is browsed on its own, so this works without a search term or location.", "items": { "type": "string" }, "default": [] }, "propertyTypes": { "title": "🏠 Property Types", "type": "array", "description": "Only these property types. Leave empty for all types.", "items": { "type": "string", "enum": [ "SINGLE_FAMILY", "TOWNHOUSE", "CONDO", "MULTI_FAMILY", "MOBILE_HOME", "LAND", "OTHER" ], "enumTitles": [ "Single family", "Townhouse", "Condo", "Multi-family", "Mobile home", "Land", "Other" ] }, "default": [] }, "minPrice": { "title": "💲 Min Price (USD)", "minimum": 0, "type": "integer", "description": "Lowest asking price in whole US dollars." }, "maxPrice": { "title": "💲 Max Price (USD)", "minimum": 0, "type": "integer", "description": "Highest asking price in whole US dollars." }, "minBeds": { "title": "🛏️ Min Bedrooms", "minimum": 0, "type": "integer", "description": "Fewest bedrooms." }, "maxBeds": { "title": "🛏️ Max Bedrooms", "minimum": 0, "type": "integer", "description": "Most bedrooms. Listings that do not state a bedroom count are kept." }, "minBaths": { "title": "🛁 Min Bathrooms", "minimum": 0, "type": "integer", "description": "Fewest bathrooms." }, "maxBaths": { "title": "🛁 Max Bathrooms", "minimum": 0, "type": "integer", "description": "Most bathrooms. Listings that do not state a bathroom count are kept." }, "minSqft": { "title": "📐 Min Square Feet", "minimum": 0, "type": "integer", "description": "Smallest living area in square feet." }, "maxSqft": { "title": "📐 Max Square Feet", "minimum": 0, "type": "integer", "description": "Largest living area in square feet." }, "maxResults": { "title": "💯 Max Results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum total results (0 = unlimited).", "default": 100 }, "startUrls": { "title": "🔗 Start URLs", "type": "array", "description": "Paste fsbo.com URLs: search results (fsbo.com/search?q=...), state pages (fsbo.com/search/list/state/tx), city pages (fsbo.com/search/list/miami-fl, optionally narrowed by type such as /land) or single listing pages (fsbo.com/search/). Each URL becomes its own search task; results are merged and deduped by listing ID across all URLs. When provided, startUrls REPLACE the query/location fields (each supported URL becomes one task; unsupported URLs are skipped, and if none is supported the run stops with an input error).", "items": { "type": "string" }, "default": [] }, "includeDetails": { "title": "📋 Include Full Details", "type": "boolean", "description": "Fetch full listing details.", "default": true }, "descriptionMaxLength": { "title": "✂️ Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate description to N chars. 0 = no truncation.", "default": 0 }, "compact": { "title": "📦 Compact Output", "type": "boolean", "description": "Core fields only (for AI-agent/MCP workflows).", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "all", "text", "html", "markdown" ], "type": "string", "description": "Pick a single description representation. `all` keeps every variant; `text` / `html` / `markdown` drop the others.", "default": "all" }, "excludeEmptyFields": { "title": "Exclude empty fields from output", "type": "boolean", "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.", "default": false }, "incrementalMode": { "title": "♻️ Incremental Mode", "type": "boolean", "description": "Compare against previous run state. stateKey is optional — defaults to a value derived from search inputs (queries, locations, startUrls, country) so different filter sets never share state.", "default": false }, "stateKey": { "title": "🔑 State Key", "type": "string", "description": "Optional. Stable identifier for the tracked search universe. Leave empty to auto-generate from search inputs." }, "skipReposts": { "title": "🚫 Skip Reposts", "type": "boolean", "description": "When incremental, skip listings whose content matches an expired listing from a prior run (cross-run duplicate detection).", "default": false }, "emitUnchanged": { "title": "🔄 Emit Unchanged Listings", "type": "boolean", "description": "When incremental mode is on, also emit listings whose content has not changed since the last run.", "default": false }, "emitExpired": { "title": "⚰️ Emit Expired Listings", "type": "boolean", "description": "When incremental mode is on, also emit listings that were seen before but are no longer found.", "default": false }, "notifyOnlyChanges": { "title": "🔄 Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for NEW and UPDATED listings. Has no effect outside incremental mode.", "default": false }, "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 }, "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 (e.g. \"-100123456789\"). Required when telegramToken is set." }, "discordWebhookUrl": { "title": "🎮 Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Server Settings → Integrations → Webhooks → New Webhook." }, "slackWebhookUrl": { "title": "💼 Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "📞 WhatsApp Phone Number ID", "type": "string", "description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set." }, "whatsappAccessToken": { "title": "📱 WhatsApp Access Token", "type": "string", "description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window — free since Nov 2024)." }, "whatsappTo": { "title": "📲 WhatsApp Recipient", "type": "string", "description": "Recipient phone in E.164 format without + (e.g. \"436641234567\"). Recipient must have messaged your business number within last 24h." }, "webhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends." }, "webhookHeaders": { "title": "📋 Webhook Headers", "type": "object", "description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})." }, "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 any contact details). Best-effort across MCP connectors as Apify expands its 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." }, "lat": { "title": "🌐 Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Latitude of the centre point for a radius filter. Use together with Longitude and Search Radius." }, "lon": { "title": "🌐 Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Longitude of the centre point for a radius filter. Use together with Latitude and Search Radius." }, "radiusKm": { "title": "📏 Search Radius (km)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Only keep listings within this many kilometres of the centre point. Listings without map coordinates are left out. Combine it with a city, state or ZIP in Location to keep the run small." } } }, "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 } } } } } } } } } }