# Clutch (Canada) — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://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 thousands of used vehicles across Canada with detailed specs, pricing, and history, then calculate loan payments to find your next car. Access comprehensive vehicle information including photos, available makes and models, and recent offers all in one place.

**Category:** Automotive | **Website:** [clutch.ca/](https://clutch.ca/) | **Docs:** [parse.bot/marketplace/e3c91364-6396-4ac9-8489-117d853add57/clutch-ca-api](https://parse.bot/marketplace/e3c91364-6396-4ac9-8489-117d853add57/clutch-ca-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### calculate_car_loan

Calculate estimated car loan payments for a given vehicle price. Returns payment amount, total interest, and total cost based on loan term, APR, down payment, and trade-in value. Uses 13% HST (Ontario). Computation is local, no upstream API call.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `apr` | number | No | Annual Percentage Rate (%) |
| `down_payment` | number | No | Down payment amount in CAD |
| `frequency` | string | No | Payment frequency |
| `loan_term` | integer | No | Loan term in months |
| `price` | number | Yes | Vehicle price in CAD |
| `trade_in_value` | number | No | Trade-in value amount in CAD |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/calculate_car_loan \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"apr":"<number>","down_payment":"<number>","frequency":"<string>","loan_term":"<integer>","price":"<number>","trade_in_value":"<number>"}'
```

### get_lookups

Retrieve metadata for all filter options including makes, models, body styles, fuel types, drivetrains, transmissions, colors, and vehicle features. Useful for building filter UIs or validating filter values before calling search_vehicles.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/get_lookups \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_makes_list

Retrieve the list of all available vehicle makes/brands. Each make includes a UUID identifier and name. The list is sourced from the site's lookup data and includes all makes with vehicles in inventory.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/get_makes_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_models_by_make

Retrieve all available models for a specific make, filtered by make_id UUID. Returns an array of model objects each with a UUID, name, and parent makeId reference.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `make_id` | string | Yes | UUID of the make (from get_makes_list results[*].id) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/get_models_by_make \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"make_id":"<string>"}'
```

### get_recent_offers

Retrieve sample recent purchase offers showing vehicles recently bought through Clutch. Each offer includes year, make, model, price, province, and location.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/get_recent_offers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_vehicle_details

Retrieve full details for a specific vehicle by its numeric ID, including specifications, pricing, photos, features, warranties, and disclosure information. The pricing object is fetched separately and includes province-specific price, admin fee, and previous price.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vehicle_id` | string | Yes | Numeric vehicle ID (from search_vehicles results[*].id) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/get_vehicle_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_id":"<string>"}'
```

### get_vehicle_photos

Retrieve all photo URLs for a specific vehicle. Returns a flat array of photo URLs covering static shots, exterior, exterior spin, and interior views. Each URL points to fastly.clutch.ca.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vehicle_id` | string | Yes | Numeric vehicle ID (from search_vehicles results[*].id) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/get_vehicle_photos \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_id":"<string>"}'
```

### search_vehicles

Search for vehicles with various filters including make, model, year, price, mileage, body type, and fuel type. Returns paginated results with vehicle summaries including pricing and photos. Pagination is zero-indexed. Each vehicle summary includes nested make/model/trim objects, body style, fuel type, and province-specific pricing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body_type` | string | No | Vehicle body style (e.g. SUV, Sedan, Hatchback, Coupe, Minivan, Pickup Truck, Convertible, Wagon) |
| `fuel_type` | string | No | Fuel type (e.g. Gasoline, Electric, Hybrid, Plug-In Hybrid) |
| `limit` | integer | No | Number of results per page |
| `make` | string | No | Vehicle make/brand name (e.g. Toyota, Honda, Tesla) |
| `max_mileage` | integer | No | Maximum mileage in km |
| `max_price` | integer | No | Maximum price in CAD |
| `max_year` | integer | No | Maximum manufacturing year |
| `min_mileage` | integer | No | Minimum mileage in km |
| `min_price` | integer | No | Minimum price in CAD |
| `min_year` | integer | No | Minimum manufacturing year |
| `model` | string | No | Vehicle model name (e.g. Corolla, Civic, Model 3) |
| `on_sale` | string | No | Filter for vehicles on sale. Accepted values: true, false |
| `page` | integer | No | Page number (0-indexed) |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-clutch-ca-api-e3c91364/search_vehicles \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body_type":"<string>","fuel_type":"<string>","limit":"<integer>","make":"<string>","max_mileage":"<integer>","max_price":"<integer>","max_year":"<integer>","min_mileage":"<integer>","min_price":"<integer>","min_year":"<integer>","model":"<string>","on_sale":"<string>","page":"<integer>","sort":"<string>"}'
```