{ "openapi": "3.0.1", "info": { "title": "Minnesota Franchise Registrations Scraper", "description": "Extract franchise registration filings from Minnesota's official CARDS system. Get franchisor names, brand names, document types, filing years, file numbers, dates, and direct PDF links to FDDs and financial statements. Filter by franchisor, brand, year, or document type.", "version": "1.0", "x-build-id": "j2z6fHt4pTv5EJ2Tg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~mn-franchise-registrations-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-mn-franchise-registrations-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/parseforge~mn-franchise-registrations-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-mn-franchise-registrations-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/parseforge~mn-franchise-registrations-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-mn-franchise-registrations-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": { "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 100. Paid users: Optional, max 1,000,000." }, "documentType": { "title": "Document Type", "enum": [ "", "Acknowledgement", "Additional funds request", "Advertisement", "Advertisement Notice", "Application and Certification (Form A)", "Application and Forms", "Application, Certification, Consent to Service of Process", "Application (Form A)", "Auditor's Consent (Form F)", "Bond", "Bond email", "Certification Page (Form A)", "Clean FDD", "Consent to Service of Process (Form C)", "Corporate Acknowledgement", "Cost and Sources of Funds (Form B)", "Cover letter", "Cover Letter and Application", "Cover letter response", "Deficiency Notice", "Deferral", "Escrow Agreement", "Exemption 80C.03(e)", "Exemption 80C.03(g)", "Final FDD", "Financial Statements", "Franchise agreement", "Franchise Exemption Effectiveness", "Guarantee of Performance (Form E)", "Marked FDD", "Order Amending Registration", "Order of Cancellation", "Order of Registration and Instructions", "Order of Renewed Registration", "Order of Renewed Registration w Amendment", "Order Reinstating Registration", "Order of Withdrawal - 120 Day", "Order of Withdrawal - Incomplete submission", "Order of Withdrawal - Reminder", "Order Vacating Cancellation", "Other", "Other Letter", "Post-effective Amendment", "Pre-effective amendment", "Refund letter", "Rejection Notice", "Response Letter", "Revised FDD - Clean", "Revised FDD - Marked Up", "Sellers Disclosure Document Notice", "Withdrawal - Franchisor Request" ], "type": "string", "description": "Filter by document type. 'Clean FDD' and 'Final FDD' are the most relevant for franchise data.", "default": "" }, "franchisor": { "title": "Franchisor Name", "type": "string", "description": "Filter by franchisor legal name. Partial match supported (e.g. 'McDonald' matches 'McDonald's USA, LLC')." }, "franchiseName": { "title": "Franchise Brand Name", "type": "string", "description": "Filter by franchise brand name (e.g. 'Subway', 'Anytime Fitness')." }, "year": { "title": "Year", "type": "string", "description": "Filter by filing year (e.g. '2024')." }, "fileNumber": { "title": "File Number", "type": "string", "description": "Filter by Minnesota file number (e.g. '11143')." }, "documentTitle": { "title": "Document ID", "type": "string", "description": "Filter by document reference number (e.g. '35042-202511-06')." }, "contentSearch": { "title": "Content Search", "type": "string", "description": "Search within document content." } } }, "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 } } } } } } } } } }