{ "openapi": "3.0.1", "info": { "title": "Franchise Investment Data — FDD Costs, Fees & Unit Counts", "description": "Returns one structured record per US franchise brand: initial investment range, franchise fee, royalty and ad-fund rates, unit counts and 3-year growth, FDD Item 19 revenue, and derived payback, fee-burden and health scores. 171 brands read out of filed Franchise Disclosure Documents. No PII.", "version": "0.1", "x-build-id": "WxQvGdSNVCT0aBdHX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jakedata~franchise-investment-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jakedata-franchise-investment-data", "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/jakedata~franchise-investment-data/runs": { "post": { "operationId": "runs-sync-jakedata-franchise-investment-data", "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/jakedata~franchise-investment-data/run-sync": { "post": { "operationId": "run-sync-jakedata-franchise-investment-data", "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": { "brands": { "title": "Brands", "type": "array", "description": "Slugs or brand names, e.g. [\"dunkin\",\"Great Clips\"]. Leave empty to browse the whole dataset with the filters below.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Restrict to these categories: Automotive, Business Services, Casual Dining, Education, Fitness, Food, Health and Wellness, Home Services, Hospitality, Personal Services, Pet, QSR, Real Estate, Retail, Senior Care, Staffing.", "items": { "type": "string" } }, "maxInvestmentUsd": { "title": "Maximum initial investment (USD)", "minimum": 0, "type": "integer", "description": "Keep only brands whose cheapest way in fits this budget. Compared against the low end of FDD Item 7." }, "requireItem19": { "title": "Only brands that disclose earnings", "type": "boolean", "description": "Keep only brands with an FDD Item 19 financial performance representation. 150 of 171 have one; the rest disclose nothing about revenue.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "health_score", "investment_low", "investment_high", "total_units", "revenue", "payback_period", "growth", "brand" ], "type": "string", "description": "Order the results before the limit is applied.", "default": "health_score" }, "limit": { "title": "Maximum records", "minimum": 0, "maximum": 500, "type": "integer", "description": "Cap the number of brands returned. Set 0 for every match. Ignored when you name brands explicitly — an explicit request is never truncated.", "default": 50 }, "minInvestmentUsd": { "title": "Minimum initial investment (USD)", "minimum": 0, "type": "integer", "description": "Drop brands whose whole range sits below this. Compared against the high end of FDD Item 7." }, "updatedSince": { "title": "Filed since", "type": "string", "description": "ISO date, e.g. 2025-01-01. Keep only brands whose latest FDD is from that year onward — use it to sync incrementally instead of re-pulling the whole dataset." }, "includeInvestmentBreakdown": { "title": "Include Item 7 line items", "type": "boolean", "description": "Attach the full startup cost breakdown per brand (real estate, equipment, signage, opening inventory, working capital) plus the FDD's own footnotes.", "default": false }, "includeFeeSchedule": { "title": "Include the full fee schedule", "type": "boolean", "description": "Attach every other upfront and recurring fee named in FDD Items 5 and 6 — technology, local advertising, POS, renewal, transfer.", "default": false }, "includeUnitHistory": { "title": "Include unit history", "type": "boolean", "description": "Attach the three-year outlet table from FDD Item 20 so you can see whether the system is opening or closing locations.", "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 } } } } } } } } } }