{ "openapi": "3.0.1", "info": { "title": "BusinessesForSale Scraper: Business Broker Listings, Financials", "description": "Scrape business broker listings from BusinessesForSale.com: asking price, revenue, cash flow, franchise investment and broker names across the US, UK, Canada, Australia and New Zealand. Filter by business type and place, or monitor for new listings and price drops.", "version": "0.2", "x-build-id": "b8vg0XurfPHRGxQku" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~businessesforsale-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-businessesforsale-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/getascraper~businessesforsale-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-businessesforsale-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/getascraper~businessesforsale-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-businessesforsale-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "BusinessesForSale category or listing pages to read, for example a search page for coffee shops or a single listing page. When set, the fields below that build a search are ignored.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchKeywords": { "title": "Business types", "type": "array", "description": "Business types to look for, such as 'coffee shops', 'car wash' or 'restaurants'. Each one is matched to the closest BusinessesForSale category.", "default": [], "items": { "type": "string" } }, "industry": { "title": "Industry / Sector", "enum": [ "all", "restaurants-food", "retail", "manufacturing", "wholesale-distribution", "service-businesses", "automotive", "construction", "healthcare-medical", "beauty-personal-care", "online-internet", "education-training", "agriculture-farming", "transportation", "real-estate-property", "hotels-motels", "bars-nightclubs", "franchises", "import-export", "leisure-entertainment" ], "type": "string", "description": "Pick a broad sector. Combines with the location below and with the business types above.", "default": "all" }, "country": { "title": "Country site", "enum": [ "global", "us", "uk", "ca", "au", "nz" ], "type": "string", "description": "Which country's listings to search. Global covers every country site.", "default": "global" }, "locationText": { "title": "Location", "type": "string", "description": "State, province or region to narrow to, for example 'California' or 'Ontario'. On the Global site use a country name such as 'Canada'. Needs a business type or sector for the best match." }, "listingType": { "title": "Listing type", "enum": [ "all", "businesses", "franchises" ], "type": "string", "description": "Keep only established businesses, only franchise opportunities, or both.", "default": "all" }, "includeVaultTeasers": { "title": "Include M&A Vault teasers", "type": "boolean", "description": "Also return the anonymised high-value deal teasers the site lists among its results. They carry revenue and a short summary but no asking price or broker.", "default": false }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to return across all searches.", "default": 25 }, "minPrice": { "title": "Min asking price", "minimum": 0, "type": "integer", "description": "Only listings asking at least this much, in the listing's own currency. Listings that do not show a price are skipped." }, "maxPrice": { "title": "Max asking price", "minimum": 0, "type": "integer", "description": "Only listings asking at most this much, in the listing's own currency." }, "minRevenue": { "title": "Min annual revenue", "minimum": 0, "type": "integer", "description": "Only listings with at least this revenue. Listings that do not show revenue are skipped." }, "maxRevenue": { "title": "Max annual revenue", "minimum": 0, "type": "integer", "description": "Only listings with at most this revenue." }, "minCashFlow": { "title": "Min cash flow", "minimum": 0, "type": "integer", "description": "Only listings with at least this annual cash flow or profit. Listings that do not show it are skipped." }, "maxCashFlow": { "title": "Max cash flow", "minimum": 0, "type": "integer", "description": "Only listings with at most this annual cash flow or profit." }, "sortOrder": { "title": "Sort order", "enum": [ "newest", "featured", "price-desc", "price-asc", "revenue-desc", "revenue-asc", "profit-desc", "profit-asc" ], "type": "string", "description": "Order of the returned listings. The site's own order is newest first; the other choices rank the listings collected in this run, so raise Max listings to rank across more of the market.", "default": "newest" }, "deepScrape": { "title": "Add broker and full details", "type": "boolean", "description": "Open every listing page to add the broker name and their listing count, full description, key selling points, photos, seller reference and extra facts. Slower, same price per listing.", "default": false }, "enrichEmails": { "title": "Find contact emails", "type": "boolean", "description": "Also look up a contact email for each listing: read the listing page and, when it links the business's own website, that site's homepage and contact page. Found emails go in a contact_emails field. Opens extra pages per listing, so runs are slower. Many listings have no public email and are simply left without one, never a made-up address.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Give this search a name to track it between runs. The Actor remembers what it has seen and flags new listings and price changes. Leave empty for a plain one-off run." }, "onlyChanges": { "title": "Only new and changed", "type": "boolean", "description": "With a monitor name set, return only new listings, price changes and edited listings. Switch off to return every listing with its status.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Used only if the site refuses a direct connection. Leave the default to let the Actor pick a route; choose groups or your own proxies to force one.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }