{ "openapi": "3.0.1", "info": { "title": "Franchise Direct Scraper", "description": "Scrape FranchiseDirect.com franchise opportunity listings. Browse by industry, filter by investment range, filter by country or US state, or pull curated Top / New franchise lists.", "version": "1.0", "x-build-id": "AFcnqU6LdsO7dfA6d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~franchise-direct-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-franchise-direct-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/crawlerbros~franchise-direct-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-franchise-direct-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/crawlerbros~franchise-direct-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-franchise-direct-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "topFranchises", "newFranchises", "collection" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Keyword search", "type": "string", "description": "Free-text keyword (mode=search), e.g. a franchise name or niche like `pizza` or `cleaning`. If `industry` or `location` is also set, FranchiseDirect's own search only reliably filters by one axis server-side, so results are navigated by industry/location first and the keyword is then applied as a relevance check on top.", "default": "food" }, "industry": { "title": "Industry category", "enum": [ "any", "accounting-financial-franchises", "advertising-marketing-franchises", "automotive-franchises", "business-opportunities", "business-services-franchises", "childrens-franchises", "cleaning-franchises", "coffee-franchises", "computer-internet-franchises", "consultant-business-broker-franchises", "courier-franchises", "employment-staffing-franchises", "entertainment-franchises", "fitness-franchises", "food-franchises", "franchise-service-providers", "golf-franchises", "health-beauty-franchises", "healthcare-senior-care-franchises", "home-based-franchises", "home-services-franchises", "industrial-franchises", "mailing-shipping-franchises", "moving-storage-franchises", "pet-franchises", "photography-franchises", "post-covid-franchises", "printer-copying-sign-franchises", "real-estate-franchises", "restaurant-franchises", "retail-franchises", "sports-franchises", "tax-franchises", "training-franchises", "travel-franchises", "vending-atm-franchises" ], "type": "string", "description": "Browse by FranchiseDirect's real industry taxonomy (mode=search).", "default": "food-franchises" }, "location": { "title": "Country / US state", "enum": [ "any", "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", "afghanistan", "albania", "algeria", "american-samoa", "andorra", "angola", "anguilla", "antigua-barbuda", "argentina", "armenia", "aruba", "australia", "austria", "azerbaijan", "bahamas", "bahrain", "bangladesh", "barbados", "belarus", "belgium", "belize", "benin", "bermuda", "bhutan", "bolivia", "bosnia-and-herzegovina", "botswana", "brazil", "brunei-darussalam", "bulgaria", "burkina-faso", "burundi", "cambodia", "cameroon", "canada", "cape-verde", "cayman-islands", "central-african-republic", "chad", "chile", "china", "christmas-island", "cocos-islands", "colombia", "comoros", "congo", "cook-islands", "coral-sea-islands", "costa-rica", "croatia", "cuba", "cyprus", "czech-republic", "democratic-republic-congo", "denmark", "djibouti", "dominica", "dominican-republic", "east-timor", "ecuador", "egypt", "el-salvador", "equatorial-guinea", "eritrea", "estonia", "ethiopia", "falkland-islands", "faroe-islands", "fiji", "finland", "france", "french-guiana", "french-polynesia", "gabon", "gambia", "gaza", "germany", "ghana", "gibraltar", "greece", "greenland", "grenada", "guadeloupe", "guam", "guatemala", "guinea", "guinea-bissau", "guyana", "haiti", "honduras", "hong-kong", "hungary", "iceland", "india", "indonesia", "iran", "iraq", "ireland", "israel", "italy", "ivory-coast", "jamaica", "japan", "jordan", "kazakhstan", "kenya", "kiribati", "kosovo", "kuwait", "kyrgyzstan", "laos", "latvia", "lebanon", "lesotho", "liberia", "libya", "liechtenstein", "lithuania", "luxembourg", "macau", "madagascar", "malawi", "malaysia", "maldives", "mali", "malta", "marshall-islands", "martinique", "mauritania", "mauritius", "mexico", "micronesia", "moldova", "monaco", "mongolia", "montenegro", "montserrat", "morocco", "mozambique", "myanmar", "namibia", "nauru", "nepal", "netherlands", "netherlands-antilles", "new-caledonia", "new-zealand", "nicaragua", "niger", "nigeria", "niue", "norfolk-island", "northern-mariana-islands", "north-korea", "north-macedonia", "norway", "oman", "pakistan", "palau", "panama", "papua-new-guinea", "paraguay", "peru", "philippines", "pitcairn-island", "poland", "portugal", "puerto-rico", "qatar", "reunion", "romania", "russia", "rwanda", "saint-helena-ascension-tristan-cunha", "saint-kitts-nevis", "saint-lucia", "saint-pierre-and-miquelon", "saint-vincent-grenadines", "samoa", "san-marino", "sao-tome-principe", "saudi-arabia", "senegal", "serbia", "seychelles", "sierra-leone", "singapore", "slovakia", "slovenia", "solomon-islands", "somalia", "south-africa", "south-korea", "spain", "sri-lanka", "sudan", "suriname", "swaziland", "sweden", "switzerland", "syrian-arab-republic", "taiwan", "tajikistan", "tanzania", "thailand", "togo", "tokelau", "tonga", "trinidad-tobago", "tunisia", "turkey", "turkmenistan", "turks-caicos-islands", "tuvalu", "uganda", "ukraine", "united-arab-emirates", "united-kingdom", "unitedstatesofamerica", "uruguay", "us-outlying-islands", "uzbekistan", "vanuatu", "venezuela", "viet-nam", "virgin-islands-british", "virgin-islands-us", "wake-islands", "wallis-futuna", "west-bank", "western-sahara", "yemen", "zambia", "zimbabwe" ], "type": "string", "description": "Filter by country or US state, using FranchiseDirect's own location taxonomy (mode=search). Takes priority over `industry`/`searchQuery` for navigation since it is the most reliable single-axis browse path on the site. Note: FranchiseDirect's own filter uses one shared value for the US state of Georgia and the country of Georgia.", "default": "any" }, "investmentTier": { "title": "Investment range (max)", "enum": [ "any", "10000", "20000", "30000", "40000", "50000", "60000", "70000", "80000", "90000", "100000", "200000", "300000", "400000", "500000" ], "type": "string", "description": "Filter to franchises whose minimum investment is at or under this amount. Applied both as the primary browse axis (when no location/industry/keyword is set) and as a client-side cap on every other mode, using each franchise's actual minimum-investment figure.", "default": "any" }, "collection": { "title": "Curated collection", "enum": [ "areaDevelopers", "bestFranchises", "discoveryDays", "franchiseResales", "veteranFranchises", "greenFranchises", "homeBasedFranchises", "hotTrendingFranchises", "internationalBusiness", "lowCostFranchises", "masterFranchises", "mobileFranchises", "multiUnitFranchises", "partTimeFranchises", "popularFranchises", "recessionResilientFranchises", "sbaApprovedFranchises" ], "type": "string", "description": "Which curated collection page to pull (mode=collection only) — FranchiseDirect's own editorial lists such as low-cost, home-based, veteran-friendly, or master franchises.", "default": "lowCostFranchises" }, "homeBasedOnly": { "title": "Home-based opportunities only", "type": "boolean", "description": "Only keep franchises whose profile page confirms a home-based business model. Requires `fetchDetails=true` to take effect (home-based status is only available on the profile page, not the listing card).", "default": false }, "fetchDetails": { "title": "Fetch full profile details", "type": "boolean", "description": "Also fetch each franchise's profile page for a fuller record (financials, business type, training, home-based, financing). Roughly doubles request count.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on emitted records. FranchiseDirect renders ~12-13 results per filter combination without a browser; widen filters or run several categories to collect more.", "default": 20 } } }, "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 } } } } } } } } } }