{ "openapi": "3.0.1", "info": { "title": "Entrepreneur Franchise 500 Scraper - Rankings & Investment", "description": "THE definitive annual US franchise ranking - 500 franchises with financial + growth data. Built for franchise consultants, brokers, PE firms, journalists, and prospective franchisees.", "version": "0.1", "x-build-id": "nlhkpqPigavHhFqud" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/growth-installations~entrepreneur-franchise500-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-growth-installations-entrepreneur-franchise500-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/growth-installations~entrepreneur-franchise500-scraper/runs": { "post": { "operationId": "runs-sync-growth-installations-entrepreneur-franchise500-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/growth-installations~entrepreneur-franchise500-scraper/run-sync": { "post": { "operationId": "run-sync-growth-installations-entrepreneur-franchise500-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": [ "rankingId" ], "properties": { "rankingId": { "title": "Ranking", "enum": [ "f500", "fs", "tv", "tg", "tm", "bb", "tf", "tb", "ab" ], "type": "string", "description": "Which ranking to scrape. `f500` is the flagship Franchise 500. Other IDs are specialty sub-rankings surfaced by Entrepreneur.", "default": "f500" }, "category": { "title": "Category filter (optional)", "type": "string", "description": "Restrict results to a specific category slug (e.g. `food`, `automotive`, `pets`, `health-wellness`, `home-improvement`, `business-services`, `childrens-businesses`, `financial-services`, `personal-care`, `retail`). Leave blank for all categories." }, "rankFrom": { "title": "Rank from", "minimum": 1, "maximum": 500, "type": "integer", "description": "Starting rank (1 = #1). Combined with `rankTo` to limit the range.", "default": 1 }, "rankTo": { "title": "Rank to", "minimum": 1, "maximum": 500, "type": "integer", "description": "Ending rank (500 = #500). Combined with `rankFrom` to limit the range.", "default": 500 }, "includeDetail": { "title": "Fetch detail pages", "type": "boolean", "description": "Fetch each franchise's detail page for financial fields (initial investment, franchise fee, royalty percent, ad fund percent, term length, CEO, unit breakdown, parent company, year founded, franchising since). REQUIRED for the differentiator financial fields. Disable only if you want ranking-list data only.", "default": true }, "maxConcurrency": { "title": "Max concurrent detail requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many detail pages to fetch in parallel. Entrepreneur.com has fully open robots.txt but be a good citizen.", "default": 10 } } }, "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 } } } } } } } } } }