{ "openapi": "3.0.1", "info": { "title": "Franchise & Multi-Location Finder — Chains by Category", "description": "Find chains and franchise brands by category and region: location count verified on the brand's own store locator, Wikipedia and franchise directories, HQ address and phone, franchise fee and investment range, emails and socials. No login, dataset-only, MCP-ready.", "version": "0.1", "x-build-id": "LCz0d58S3LsRBLUYk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/inovaflow~franchise-multi-location-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-inovaflow-franchise-multi-location-finder", "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/inovaflow~franchise-multi-location-finder/runs": { "post": { "operationId": "runs-sync-inovaflow-franchise-multi-location-finder", "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/inovaflow~franchise-multi-location-finder/run-sync": { "post": { "operationId": "run-sync-inovaflow-franchise-multi-location-finder", "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": "Business categories", "type": "array", "description": "One category per line, the way you would search Google Maps — e.g. `pizza`, `gym`, `dental clinic`, `car wash`, `urgent care`, `hair salon`. Each category is searched in every region.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "One region per line: a US state, Canadian province, country or metro — e.g. `Texas`, `Ontario`, `UK`, `Greater Manchester, UK`. Google Maps is searched for the region and then for its busiest cities; brands that show up more than once are the chain candidates.", "items": { "type": "string" } }, "minLocations": { "title": "Minimum locations", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Only deliver brands with at least this many locations (verified count: store locator, Wikipedia, franchise directory, the brand's own statement — or the Google Maps sample as a lower bound).", "default": 5 }, "maxBrands": { "title": "Max brands", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many brands have been delivered. Only delivered brands are charged.", "default": 50 }, "brands": { "title": "Brands to verify (optional)", "type": "array", "description": "Paste brand names or domains to look up and verify without searching by category — e.g. `Jersey Mike's`, `anytimefitness.com`. Each is searched on Google Maps by name, then enriched like any other brand.", "items": { "type": "string" } }, "franchiseOnly": { "title": "Franchises only", "type": "boolean", "description": "Deliver only brands with franchise evidence: listed on a franchise directory (Franchise Direct, Franchise Gator, IFA), a franchising page on the brand site, or Wikipedia calling it a franchise.", "default": false }, "enrichContacts": { "title": "Extract emails & socials", "type": "boolean", "description": "Reads the brand homepage plus contact / about pages and pulls out email addresses, phone numbers and Facebook / Instagram / LinkedIn / X / YouTube / TikTok links. Charged only when something was found.", "default": true }, "useDirectories": { "title": "Read franchise directories", "type": "boolean", "description": "Look each brand up on Franchise Direct, Franchise Gator and the IFA directory for franchise fee, minimum cash, total investment range, unit count and founding year.", "default": true }, "useWikipedia": { "title": "Read Wikipedia", "type": "boolean", "description": "Read the brand's Wikipedia infobox (\"Number of locations\", founded, headquarters, employees). Accepted only when the article's website matches the brand's domain.", "default": true }, "mapsPagesPerQuery": { "title": "Google Maps pages per query", "minimum": 1, "maximum": 10, "type": "integer", "description": "Result pages (20 places each) read for every region-level search; city follow-ups read up to 3.", "default": 4 }, "citiesPerRegion": { "title": "Follow-up cities per region", "minimum": 0, "maximum": 25, "type": "integer", "description": "After the region-level search, the busiest cities in the results get their own search (` in , `) so regional chains surface too. 0 disables it.", "default": 5 }, "language": { "title": "Google Maps language", "type": "string", "description": "Interface language for the Maps results (`hl`), e.g. `en`, `de`, `fr`.", "default": "en" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many brands are enriched in parallel.", "default": 6 }, "proxyConfiguration": { "title": "Proxy (fallback)", "type": "object", "description": "Every site is read through the run's own connection first (Google Maps included — it accepts the platform's egress more often than proxy ranges); this proxy is used only for hosts that block that path. RESIDENTIAL helps when Google Maps starts answering with captchas.", "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 } } } } } } } } } }