# Canada Businessesforsale — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse businesses for sale and franchise opportunities across Canada, retrieving detailed listing information to find investment opportunities that match your interests. Explore comprehensive data on available businesses and franchises to make informed decisions about potential acquisitions.

**Category:** Marketplaces | **Website:** [canada.businessesforsale.com/](https://canada.businessesforsale.com/) | **Docs:** [parse.bot/marketplace/3522fdec-ebc9-440b-a041-d94765340e1a/canada-businessesforsale-com-api](https://parse.bot/marketplace/3522fdec-ebc9-440b-a041-d94765340e1a/canada-businessesforsale-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/canada-businessesforsale/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get listing details

Retrieve full details for a specific business listing by its URL. Returns title, location, financials (asking price, revenue, cash flow), listing ID, broker name, and full description. The URL should come from search_businesses results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the listing detail page (from search_businesses results[*].url) |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/canada-businessesforsale/get-listing-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### Search businesses

Search for business listings in Canada with optional filters. Returns paginated results with basic listing information including title, location, pricing, revenue, cash flow, and tags. Results are ordered by relevance (Score) by default. Each result includes a URL that can be passed to get_listing_details for full information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | No | Category ID to filter by |
| `keywords` | string | No | Keywords to search for (e.g. 'pizza', 'restaurant', 'salon') |
| `max_price` | integer | No | Maximum asking price in CAD |
| `min_price` | integer | No | Minimum asking price in CAD |
| `page` | integer | No | Page number for pagination |
| `region_id` | string | No | Region/Province ID to filter by |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/canada-businessesforsale/search-businesses \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","keywords":"<string>","max_price":"<integer>","min_price":"<integer>","page":"<integer>","region_id":"<string>","sort":"<string>"}'
```

### Search franchises

Search for franchise opportunities in Canada. Returns paginated results with franchise name, description, URL, and minimum investment. Without keywords, returns all available franchises.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `keywords` | string | No | Keywords to search for |
| `page` | integer | No | Page number for pagination |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/canada-businessesforsale/search-franchises \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"keywords":"<string>","page":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.