{ "openapi": "3.1.0", "info": { "title": "FranchisePulse API", "description": "Global franchise intelligence API. AI-synthesized franchise discovery, FDD analysis, total cost modeling, SBA loan analysis, resale valuation, online/absentee franchise opportunities, and franchise broker comparison. Covers 4,000+ active US franchises plus international expansion opportunities. SBA lender affiliates (Benetrends, FranFund, Guidant), FranNet consultant network, and BizBuySell marketplace included. All endpoints support any language via ?lang=. Pricing: $0.10\u2013$0.20 USDC/call via x402 micropayment.", "version": "1.2.0" }, "servers": [ { "url": "https://franchisepulse-six.vercel.app" } ], "paths": { "/api/franchise/fdd": { "get": { "summary": "Franchise Disclosure Document analysis", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "franchisor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Item 7/19/20/21 analysis, ongoing fees, 5-year projection, verdict" }, "402": { "description": "$0.20" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "FDD analysis \u2014 chain after /api/franchise/discover for detailed due diligence; pairs with LegalPulse for FDD legal review", "x-price-usd": 0.2 } }, "/api/franchise/discover": { "get": { "summary": "Franchise opportunity discovery", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "industry", "in": "query", "schema": { "type": "string" } }, { "name": "investment_max", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "new_unit|resale|both" }, { "name": "territory", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ranked franchise opportunities with investment, royalty, Item 19 status, red flags" }, "402": { "description": "$0.15" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Start here for franchise discovery \u2014 SBA lender + consultant affiliate links auto-appended; chain to /api/franchise/total-cost for investment analysis", "x-price-usd": 0.15 } }, "/api/franchise/compare": { "get": { "summary": "Side-by-side franchise comparison", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "concepts", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma-separated franchise names (min 2)" }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comparison table with decisive recommendation" }, "402": { "description": "$0.15" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Side-by-side franchise comparison \u2014 chain after /api/franchise/discover to shortlist candidates", "x-price-usd": 0.15 } }, "/api/franchise/vet": { "get": { "summary": "Franchise due diligence", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "franchisor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Litigation, failure rates, franchisee satisfaction, verdict" }, "402": { "description": "$0.15" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Franchise vetting \u2014 run before any investment; chain with /api/franchise/fdd for comprehensive due diligence", "x-price-usd": 0.15 } }, "/api/franchise/total-cost": { "get": { "summary": "All-in investment and cost analysis", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "franchisor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Full cost breakdown, 5-year projection, break-even estimate" }, "402": { "description": "$0.10" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Total investment calculator \u2014 chain after /api/franchise/discover; SBA financing links auto-appended", "x-price-usd": 0.15 } }, "/api/franchise/resale": { "get": { "summary": "Existing franchise units for sale", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "industry", "in": "query", "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Franchise resale listings with SDE multiples and due diligence checklist" }, "402": { "description": "$0.10" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Existing franchise acquisition \u2014 BizBuySell affiliate link included; often better ROI than new franchise", "x-price-usd": 0.15 } }, "/api/franchise/online": { "get": { "summary": "Online business acquisition discovery", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "SaaS|content|ecommerce|newsletter|app|service" }, { "name": "min_revenue", "in": "query", "schema": { "type": "string" } }, { "name": "max_multiple", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Digital businesses for sale with market multiples context" }, "402": { "description": "$0.10" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Online/absentee franchise opportunities \u2014 pairs with CareerPulse for income replacement modeling", "x-price-usd": 0.1 } }, "/api/franchise/sba": { "get": { "summary": "SBA eligibility and franchise financing", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "franchisor", "in": "query", "schema": { "type": "string" } }, { "name": "loan_amount", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "SBA registry status, 7(a)/504 overview, ROBS structure, lender guidance" }, "402": { "description": "$0.08" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "SBA 7(a) loan analysis \u2014 SBA lender affiliate links auto-appended; pairs with WealthPulse for capital allocation", "x-price-usd": 0.15 } }, "/api/franchise/broker": { "get": { "summary": "Franchise broker and consultant guidance", "parameters": [ { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" } }, { "name": "specialty", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Broker compensation conflicts, red flags, how to find independent advisors" }, "402": { "description": "$0.08" } }, "x-agent-use-case": "on-demand", "x-agent-chaining": "Franchise broker comparison \u2014 FranNet + franchise consultant affiliates included", "x-price-usd": 0.1 } } } }