{ "openapi": "3.0.1", "info": { "title": "BizBuySell Deal Monitor & Price Drop Alerts", "description": "Monitor business-for-sale listings for new deals, asking-price changes, financial updates, and listings that leave a tracked search.", "version": "0.1", "x-build-id": "VargLk1ol7eAG8ymA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchfinch~bizbuysell-deal-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchfinch-bizbuysell-deal-monitor", "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/fetchfinch~bizbuysell-deal-monitor/runs": { "post": { "operationId": "runs-sync-fetchfinch-bizbuysell-deal-monitor", "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/fetchfinch~bizbuysell-deal-monitor/run-sync": { "post": { "operationId": "run-sync-fetchfinch-bizbuysell-deal-monitor", "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": [ "monitorKey" ], "properties": { "startUrls": { "title": "BizBuySell search URLs", "maxItems": 1, "type": "array", "description": "National or US-state BizBuySell businesses-for-sale pages. Keep these stable between runs of the same monitor.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "monitorKey": { "title": "Monitor name", "minLength": 1, "maxLength": 80, "type": "string", "description": "Stable name for this watchlist and its saved history, for example california-car-washes. Use a different name for every distinct search configuration.", "default": "default-watchlist" }, "maxItems": { "title": "Maximum listings per snapshot", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum unique listings collected across the searches on each run.", "default": 100 }, "maxPagesPerUrl": { "title": "Maximum pages per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Controls search depth and upstream extraction cost.", "default": 3 }, "enrichDetails": { "title": "Collect financial details", "type": "boolean", "description": "Visit listing pages for cash flow, gross revenue, EBITDA, real estate, inventory, and other disclosed details. Recommended for deal scoring.", "default": true }, "includeBrokerContacts": { "title": "Include public broker contacts", "type": "boolean", "description": "Collect broker fields when publicly displayed. Requires financial-detail enrichment.", "default": false }, "minAskingPrice": { "title": "Minimum asking price (USD)", "minimum": 0, "type": "integer", "description": "Exclude listings with a disclosed asking price below this amount." }, "maxAskingPrice": { "title": "Maximum asking price (USD)", "minimum": 0, "type": "integer", "description": "Exclude listings with a disclosed asking price above this amount." }, "includeKeywords": { "title": "Require one of these keywords", "type": "array", "description": "Case-insensitive terms checked against title, description, and location. Leave empty to include every listing.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude these keywords", "type": "array", "description": "A listing containing any term in its title, description, or location is left out of this monitor.", "items": { "type": "string" } }, "minDealScore": { "title": "Minimum deal score to emit", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only output events whose transparent screening score meets this threshold. State is still updated for lower-scoring listings.", "default": 0 }, "minScoreConfidence": { "title": "Minimum score confidence", "minimum": 0, "maximum": 100, "type": "integer", "description": "When a minimum deal score is active, require this percentage of the scoring evidence to be available. The default prevents revenue-only scores from passing a score filter.", "default": 50 }, "excludeFranchises": { "title": "Exclude franchise offers", "type": "boolean", "description": "Exclude franchise opportunities that can appear in state search results alongside existing businesses for sale.", "default": true }, "firstRunBehavior": { "title": "First-run behavior", "enum": [ "emit_all_as_new", "baseline_only" ], "type": "string", "description": "Emit the initial snapshot as NEW_LISTING events, or save a quiet baseline for later comparisons.", "default": "emit_all_as_new" }, "eventTypes": { "title": "Event types to output", "uniqueItems": true, "type": "array", "description": "The monitor always tracks every detected change, but only selected event types are written to the dataset.", "items": { "type": "string", "enum": [ "NEW_LISTING", "PRICE_DROP", "PRICE_INCREASE", "FINANCIALS_CHANGED", "LISTING_UPDATED", "NO_LONGER_IN_RESULTS", "UNCHANGED" ], "enumTitles": [ "New listings", "Price drops", "Price increases", "Financial changes", "Other listing updates", "No longer in results", "Unchanged listings" ] }, "default": [ "NEW_LISTING", "PRICE_DROP", "PRICE_INCREASE", "FINANCIALS_CHANGED", "LISTING_UPDATED", "NO_LONGER_IN_RESULTS" ] }, "minPriceDropPercent": { "title": "Minimum price drop percentage", "minimum": 0, "maximum": 100, "type": "number", "description": "Suppress smaller PRICE_DROP events. Other event types are unaffected.", "default": 0 }, "emitUnchanged": { "title": "Output unchanged listings", "type": "boolean", "description": "Useful for full snapshot exports, but normally disabled for alert workflows.", "default": false }, "detectMissing": { "title": "Detect listings leaving the result window", "type": "boolean", "description": "Emit NO_LONGER_IN_RESULTS after consecutive misses. Keep disabled for partial or frequently re-sorted searches to avoid false alerts.", "default": false }, "missingAfterRuns": { "title": "Consecutive misses before alert", "minimum": 1, "maximum": 10, "type": "integer", "description": "Require this many consecutive snapshots without a listing before emitting NO_LONGER_IN_RESULTS.", "default": 2 }, "resetState": { "title": "Reset this monitor before running", "type": "boolean", "description": "Deletes the saved snapshot for this monitor key, then treats the run as a new baseline.", "default": false }, "allowEmptySnapshot": { "title": "Accept an empty source snapshot", "type": "boolean", "description": "Disabled by default to protect saved state when the source unexpectedly returns no listings.", "default": false }, "sourceActorId": { "title": "Raw listing Actor", "type": "string", "description": "Advanced dependency override. The default is a low-cost public BizBuySell extraction Actor.", "default": "automation-lab/bizbuysell-business-listings-scraper" }, "sourceDatasetId": { "title": "Use an existing source dataset instead", "type": "string", "description": "Optional dataset ID for replay, testing, or custom extraction. When set, the raw listing Actor is not called." }, "sourceMaxTotalChargeUsd": { "title": "Maximum raw-source charge (USD)", "minimum": 0.01, "maximum": 100, "type": "number", "description": "Hard spending limit passed to the upstream pay-per-event Actor. Ignored when replaying an existing dataset.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration for source Actor", "type": "object", "description": "Passed to the raw extraction Actor when provided." }, "includeRawSource": { "title": "Include original source record", "type": "boolean", "description": "Adds the unnormalized source record to each event. This can substantially increase dataset size.", "default": 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 } } }, "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 } } } } } } } } } }