# Carfax — 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.

> Access data from carfax.com.

**Category:** Automotive | **Website:** [carfax.com/](https://carfax.com/) | **Docs:** [parse.bot/marketplace/1c2d366b-f072-4d33-a74b-fbee846fd511/carfax-com-api](https://parse.bot/marketplace/1c2d366b-f072-4d33-a74b-fbee846fd511/carfax-com-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-carfax-com-api-1c2d366b/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_carfax_value

Extract CARFAX Value pricing data and ratings for a vehicle listing. Returns the value badge (GREAT, GOOD, FAIR, HIGH), CARFAX price estimate (onePrice), listing price, price comparison arrows explaining the valuation factors, and monthly payment estimate. The VIN must correspond to an active listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_carfax_value \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>"}'
```

### get_dealer_details

Extract seller/dealer information from a vehicle listing including name, address, phone, business hours, ratings, badge details, and photos. The VIN must correspond to an active listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_dealer_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>"}'
```

### get_estimated_payment

Get the estimated monthly payment for a vehicle listing including loan amount, down payment, interest rate, and term. Uses standard assumptions (10% down, current market rate, 60 months). The VIN must correspond to an active listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_estimated_payment \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>"}'
```

### get_listing_detail

Retrieve full details for a specific vehicle listing by VIN. Returns comprehensive data including specs, dealer info with business hours, all images, ownership/accident/service history, pricing with CARFAX Value badge, reliability ratings, and seller comments. The VIN must correspond to an active listing on CARFAX.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings or search_new_car_listings results. |
| `zip` | string | No | 5-digit US ZIP code for location-specific data such as distance to dealer. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_listing_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>","zip":"<string>"}'
```

### get_listing_photos

Retrieve the photo gallery for a specific vehicle listing including image URLs in multiple sizes (large 640x480, medium 344x258, small 120x90). The VIN must correspond to an active listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_listing_photos \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>"}'
```

### get_vehicle_highlights

Retrieve vehicle specification highlights and features including top options, other options, standardized atom options, and a comprehensive comma-separated features string. The VIN must correspond to an active listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_vehicle_highlights \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>"}'
```

### get_vehicle_history_summary

Get a summary of the vehicle history including accidents, ownership, service records, and vehicle use. Returns boolean flags for quick checks plus detailed history objects with dates, locations, and descriptions. The VIN must correspond to an active listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `vin` | string | Yes | Vehicle Identification Number (VIN) of an active CARFAX listing. Obtain from search_used_car_listings results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_vehicle_history_summary \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"<string>"}'
```

### get_vehicle_reviews

Get consumer reviews for a specific vehicle make, model, and year. Returns individual reviews with ratings, title, comments, and category breakdowns (Exterior, Interior, Performance, Family, Cost), plus aggregate statistics including total reviews, average rating, and distribution by star rating.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `make` | string | Yes | Vehicle make (e.g. Toyota, Honda, Ford). |
| `model` | string | Yes | Vehicle model (e.g. Camry, Civic, F-150). Must correspond to the specified make. |
| `year` | string | Yes | Vehicle model year as a 4-digit string (e.g. 2023). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/get_vehicle_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"make":"<string>","model":"<string>","year":"<string>"}'
```

### search_cars_by_body_type

Search for used cars filtered by body style. Returns paginated listings matching the specified body type with the same vehicle detail structure as the general search endpoint.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body_type` | string | Yes | Vehicle body type filter. Accepted values: SUV, Sedan, Truck, Pickup, Minivan, Coupe, Convertible, Wagon, Hatchback. |
| `zip` | string | No | 5-digit US ZIP code for search location. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/search_cars_by_body_type \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body_type":"<string>","zip":"<string>"}'
```

### search_new_car_listings

Search for new car listings on CARFAX with optional make and model filters. Returns paginated results with vehicle details, MSRP pricing, and dealer information. New car listings may not have mileage or history indicators.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `make` | string | No | Vehicle make to filter by (e.g. Honda, Toyota, Ford). |
| `model` | string | No | Vehicle model to filter by (e.g. Civic, Camry, F-150). Must correspond to the specified make. |
| `zip` | string | No | 5-digit US ZIP code for search location. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/search_new_car_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"make":"<string>","model":"<string>","zip":"<string>"}'
```

### search_used_car_listings

Search for used car listings on CARFAX with various filters. Returns paginated results with vehicle details, pricing, CARFAX history indicators, dealer information, and images. Each listing includes VIN, price, mileage, accident/service/owner history summaries, and reliability ratings. Paginates via integer page counter; each page returns up to `rows` listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `make` | string | No | Vehicle make to filter by (e.g. Toyota, Honda, Ford, BMW, Subaru). |
| `model` | string | No | Vehicle model to filter by (e.g. Camry, Civic, F-150). Must correspond to the specified make. |
| `page` | integer | No | Page number for pagination (1-based). |
| `radius` | integer | No | Search radius in miles from the ZIP code. |
| `rows` | integer | No | Number of results per page (max 100). |
| `sort` | string | No | Sort order for results. |
| `zip` | string | No | 5-digit US ZIP code for search location. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-carfax-com-api-1c2d366b/search_used_car_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"make":"<string>","model":"<string>","page":"<integer>","radius":"<integer>","rows":"<integer>","sort":"<string>","zip":"<string>"}'
```