Piloterr Franchisedirect API
The Franchisedirect API from Piloterr — 2 operation(s) for franchisedirect.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-franchisedirect-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Piloterr API Reference Franchisedirect API
description: Complete API reference documentation.
version: 1.0.0
servers:
- url: https://api.piloterr.com
description: API Server
tags:
- name: Franchisedirect
paths:
/v2/franchisedirect/franchise:
get:
summary: Franchise Direct Franchise
description: 'Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training.
**Credit cost:** 1 credit per call'
operationId: get-franchisedirect-franchise
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: 'Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.
**Example:**
```
https://www.franchisedirect.com/coffee-franchises/coffeenow
```'
schema:
type: string
description: 'Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.
**Example:**
```
https://www.franchisedirect.com/coffee-franchises/coffeenow
```'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
url:
type: string
name:
type: string
image:
type: string
industry:
type: string
description:
type: string
business_type:
type: string
franchise_fee:
type: integer
training_provided:
type: boolean
available_locations:
type: string
financing_assistance:
type: string
total_investment_max:
type: integer
total_investment_min:
type: integer
franchise_fee_display:
type: string
minimum_cash_required:
type: integer
total_investment_display:
type: string
minimum_cash_required_display:
type: string
examples:
CoffeeNow:
value:
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
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Franchisedirect
post:
summary: Franchise Direct Franchise
description: 'Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training.
**Credit cost:** 1 credit per call'
operationId: post-franchisedirect-franchise
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: 'Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.
**Example:**
```
https://www.franchisedirect.com/coffee-franchises/coffeenow
```'
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
url:
type: string
name:
type: string
image:
type: string
industry:
type: string
description:
type: string
business_type:
type: string
franchise_fee:
type: integer
training_provided:
type: boolean
available_locations:
type: string
financing_assistance:
type: string
total_investment_max:
type: integer
total_investment_min:
type: integer
franchise_fee_display:
type: string
minimum_cash_required:
type: integer
total_investment_display:
type: string
minimum_cash_required_display:
type: string
examples:
CoffeeNow:
value:
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
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Franchisedirect
/v2/franchisedirect/search:
get:
summary: Franchise Direct Search
description: 'Search Franchise Direct listings by keyword or listing URL. Each card includes a USD cash figure and a numeric minimum.
**Credit cost:** 1 credit per call'
operationId: get-franchisedirect-search
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: 'Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.
**Example:**
```
coffee
```
**URL example:**
```
https://www.franchisedirect.com/search?q=coffee
```'
schema:
type: string
description: 'Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.
**Example:**
```
coffee
```
**URL example:**
```
https://www.franchisedirect.com/search?q=coffee
```'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
url:
type: string
name:
type: string
image:
type: string
category:
type: string
description:
type: string
minimum_cash_required:
type: integer
minimum_cash_required_display:
type: string
pagination:
type: object
properties:
next:
nullable: true
page:
type: integer
per_page:
type: integer
total_pages:
nullable: true
total_results:
nullable: true
examples:
CoffeeNow:
value:
results:
- url: https://www.franchisedirect.com/coffee-franchises/coffeenow
name: CoffeeNow
image: https://static4.franchisedirect.ie/dims4/default/5f4574f/2147483647/strip/true/crop/350x220+0+0/resize/255x160!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg
category: 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.
minimum_cash_required: 60000
minimum_cash_required_display: $60,000
pagination:
next: null
page: 1
per_page: 6
total_pages: null
total_results: null
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Franchisedirect
post:
summary: Franchise Direct Search
description: 'Search Franchise Direct listings by keyword or listing URL. Each card includes a USD cash figure and a numeric minimum.
**Credit cost:** 1 credit per call'
operationId: post-franchisedirect-search
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: 'Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.
**Example:**
```
coffee
```
**URL example:**
```
https://www.franchisedirect.com/search?q=coffee
```'
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
url:
type: string
name:
type: string
image:
type: string
category:
type: string
description:
type: string
minimum_cash_required:
type: integer
minimum_cash_required_display:
type: string
pagination:
type: object
properties:
next:
nullable: true
page:
type: integer
per_page:
type: integer
total_pages:
nullable: true
total_results:
nullable: true
examples:
CoffeeNow:
value:
results:
- url: https://www.franchisedirect.com/coffee-franchises/coffeenow
name: CoffeeNow
image: https://static4.franchisedirect.ie/dims4/default/5f4574f/2147483647/strip/true/crop/350x220+0+0/resize/255x160!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg
category: 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.
minimum_cash_required: 60000
minimum_cash_required_display: $60,000
pagination:
next: null
page: 1
per_page: 6
total_pages: null
total_results: null
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Franchisedirect
components:
parameters:
fields:
name: fields
in: query
required: false
description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
schema:
type: string
is_async:
name: is_async
in: query
required: false
description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
schema:
type: boolean
default: false
soft_fail:
name: soft_fail
in: query
required: false
description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
schema:
type: boolean
default: false
schemas:
ErrorResponse:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable error message.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Your API key. Include it in the x-api-key header for every request.