Read one franchise profile on Franchise Direct. Pass the profile URL from search. The response is a flat record. Dollar fields come in pairs: a printed string and the whole-dollar numbers parsed from it.
CoffeeNow at https://www.franchisedirect.com/coffee-franchises/coffeenow returns minimum_cash_required 60000 with minimum_cash_required_display $60,000, the same pair as the search card. The profile also adds the franchise fee and the total investment range.
GET https://api.piloterr.com/v2/franchisedirect/franchise?query=https://www.franchisedirect.com/coffee-franchises/coffeenow
GET https://api.piloterr.com/v2/franchisedirect/franchise?query=https://www.franchisedirect.com/food-franchises/3-men-a-bagel/
GET and POST take the same query. The second URL is the 3 Men & a Bagel card from a coffee search, and the profile cash is 250000 / $250,000, matching that card.
| Parameter |
Required |
Example |
query |
yes |
https://www.franchisedirect.com/coffee-franchises/coffeenow |
query is required. It must be a profile on franchisedirect.com: a path with at least two segments that is not search, directory, or industries. A relative path such as /coffee-franchises/coffeenow is accepted. A keyword or a listing URL returns 400.
| Field |
Type |
Meaning |
name |
string |
Franchise name |
url |
string |
Profile URL without a query string |
description |
string or null |
Profile summary |
industry |
string or null |
Breadcrumb category, otherwise the category from the path |
image |
string or null |
Logo |
business_type |
string or null |
Business type, such as Franchise |
available_locations |
string or null |
Where units are offered, including excluded states when the page prints them |
financing_assistance |
string or null |
Financing note |
training_provided |
boolean or null |
true or false when the page says yes or no. null when the line is absent |
minimum_cash_required |
number or null |
Minimum cash in whole dollars |
minimum_cash_required_display |
string or null |
Printed minimum, such as $60,000 |
franchise_fee |
number or null |
Franchise fee in whole dollars |
franchise_fee_display |
string or null |
Printed fee, such as $25,000 |
total_investment_min |
number or null |
Low end of the investment range |
total_investment_max |
number or null |
High end. null when the page prints a single amount |
total_investment_display |
string or null |
Printed range, such as $133,000 - $309,000 |
On CoffeeNow the fee pair is 25000 and $25,000, and the investment pair is 133000 to 309000 with display $133,000 - $309,000. training_provided is true. There is no results wrapper.
- Compare CoffeeNow's
$25,000 fee and $133,000 - $309,000 investment with another profile opened from the same search.
- Read
available_locations to see where single-unit CoffeeNow opportunities are offered and which states the profile excludes.
- Check
training_provided and financing_assistance before a first call with the brand.
| Code |
Meaning |
400 |
Empty query, a listing URL, or a domain outside franchisedirect.com |
401 |
Missing API key |
404 |
The page is not a franchise profile |
500 |
The fetch failed |
Franchise Direct Search
