# Franchise Direct Franchise

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/franchisedirect/franchise` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/franchisedirect-franchise |

## Description

Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/franchisedirect/franchise' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### CoffeeNow

```json
{
  "url": "https://www.franchisedirect.com/coffee-franchises/coffeenow",
  "name": "CoffeeNow",
  "image": "https://static4.franchisedirect.ie/dims4/default/234c6dc/2147483647/strip/true/crop/350x220+0+0/resize/270x170!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg",
  "industry": "Coffee Franchises",
  "description": "Bring the coffee shop experience directly to local workplaces with a technology-driven mobile franchise that eliminates the need for a traditional storefront. CoffeeNow combines custom-outfitted coffee vans, proprietary ordering technology, and recurring B2B routes to help entrepreneurs build a scalable business around the weekday workday.",
  "business_type": "Franchise",
  "franchise_fee": 25000,
  "training_provided": true,
  "available_locations": "Single-unit opportunities available throughout the US, EXCLUDING: CA, HI, IL, IN, MD, MI, MN, NY, ND, RI, SD, VA, WA, WI.",
  "financing_assistance": "None",
  "total_investment_max": 309000,
  "total_investment_min": 133000,
  "franchise_fee_display": "$25,000",
  "minimum_cash_required": 60000,
  "total_investment_display": "$133,000 - $309,000",
  "minimum_cash_required_display": "$60,000"
}
```

## Documentation

## Overview

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.

## Quickstart

```
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.

## Parameters

| 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.

## Response fields

| 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.

## Use cases

- 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.

## Error codes

| 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 |

## Related endpoints

[Franchise Direct Search](https://www.piloterr.com/library/franchisedirect-search)