{
"openapi": "3.0.1",
"info": {
"title": "BizBuySell Franchises for Sale Scraper",
"description": "Scrape franchise opportunities from BizBuySell. Filter by category, investment range and state, and get franchises with fees, royalties, unit counts and territories.",
"version": "0.1",
"x-build-id": "BQAuUcE4s04wUIYqH"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/datacach~bizbuysell-franchises-for-sale-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-datacach-bizbuysell-franchises-for-sale-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/datacach~bizbuysell-franchises-for-sale-scraper/runs": {
"post": {
"operationId": "runs-sync-datacach-bizbuysell-franchises-for-sale-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/datacach~bizbuysell-franchises-for-sale-scraper/run-sync": {
"post": {
"operationId": "run-sync-datacach-bizbuysell-franchises-for-sale-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": {
"categories": {
"title": "Franchise categories",
"type": "array",
"description": "Only return franchises listed under these BizBuySell categories, e.g. Restaurant and Food or Home Services. Categories are combined with OR, so picking several widens the search. Leave empty to scrape every category.",
"items": {
"type": "string",
"enum": [
"Automotive",
"Beauty and Fitness",
"Business Opportunities",
"Business Services",
"Child Related",
"Cleaning and Maintenance",
"Computer and Internet",
"Education",
"Franchise Consultants",
"Franchise Financing",
"Green",
"Health and Senior Care",
"High Capital Franchises",
"Home Based Businesses",
"Home Services",
"Hot Franchises",
"Low Cost Franchises",
"Master Franchise",
"Mobile",
"Multi-Unit",
"Pet",
"Restaurant and Food",
"Retail Franchises",
"SBA Approved",
"Sports and Recreation",
"Spotlight Franchises",
"Travel and Lodging",
"Veteran's Franchises"
]
},
"default": []
},
"states": {
"title": "Available in states",
"type": "array",
"description": "Only return franchises that are opening locations in at least one of these US states, e.g. TX or CA. This is where the franchise offers territories, not where its head office is, so a brand headquartered in Florida still matches Texas if it sells Texas territories. Leave empty for nationwide coverage.",
"items": {
"type": "string",
"enum": [
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VA",
"WA",
"WV",
"WI",
"WY"
],
"enumTitles": [
"Alabama",
"Alaska",
"Arizona",
"Arkansas",
"California",
"Colorado",
"Connecticut",
"Delaware",
"District of Columbia",
"Florida",
"Georgia",
"Hawaii",
"Idaho",
"Illinois",
"Indiana",
"Iowa",
"Kansas",
"Kentucky",
"Louisiana",
"Maine",
"Maryland",
"Massachusetts",
"Michigan",
"Minnesota",
"Mississippi",
"Missouri",
"Montana",
"Nebraska",
"Nevada",
"New Hampshire",
"New Jersey",
"New Mexico",
"New York",
"North Carolina",
"North Dakota",
"Ohio",
"Oklahoma",
"Oregon",
"Pennsylvania",
"Rhode Island",
"South Carolina",
"South Dakota",
"Tennessee",
"Texas",
"Utah",
"Vermont",
"Virginia",
"Washington",
"West Virginia",
"Wisconsin",
"Wyoming"
]
},
"default": []
},
"keyword": {
"title": "Brand name contains",
"type": "string",
"description": "Only return franchises whose brand name contains this text, e.g. pizza matches \"Pizza Hut\" and \"Marco's Pizza\". Case-insensitive, and matched against the brand name only — not the description. Leave empty to keep every brand.",
"default": ""
},
"includeInactive": {
"title": "Include inactive listings",
"type": "boolean",
"description": "Turn on to also collect franchises whose advertiser is no longer active, which roughly doubles the results but adds listings whose financial fields are often incomplete. Off (the default) returns only the ~900 franchises the site actually shows today.",
"default": false
},
"investmentMin": {
"title": "Minimum total investment",
"minimum": 0,
"type": "integer",
"description": "Only return franchises whose total investment is at or above this amount in US dollars, e.g. 50000. Must not be greater than the maximum. Leave at 0 for no lower limit.",
"default": 0
},
"investmentMax": {
"title": "Maximum total investment",
"minimum": 0,
"type": "integer",
"description": "Only return franchises whose total investment is at or below this amount in US dollars, e.g. 250000. Leave at 0 for no upper limit.",
"default": 0
},
"maxResults": {
"title": "Maximum results",
"minimum": 0,
"type": "integer",
"description": "Stop after this many franchises. Set to 0 to collect everything that matches your filters (~900 with the default filters). You are charged per result, so start small to preview the data and raise the limit once the output looks right. Free plan is capped at 25 results, including when this is set to 0.",
"default": 50
}
}
},
"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
}
}
}
}
}
}
}
}
}
}