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

> Browse and search National Liquidators' inventory of boats, yachts, and other vessels available for auction, with access to detailed listings, live auctions, featured items, and recently listed vessels. Filter by vessel makes and types to find your next acquisition.

**Category:** Marketplaces | **Website:** [yachtauctions.com/](https://yachtauctions.com/) | **Docs:** [parse.bot/marketplace/6de8dd22-e61f-46b1-af57-b616a447d43c/yachtauctions-com-api](https://parse.bot/marketplace/6de8dd22-e61f-46b1-af57-b616a447d43c/yachtauctions-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-yachtauctions-com-api-6de8dd22/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_vessel_detail

Get detailed information for a specific vessel by its slug. Returns title, asking price, contact info, specifications, description, and photos. Returns input_not_found if the vessel no longer exists or has been removed.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Vessel listing slug from list_vessel_listings or search_vessels results (e.g. '2019-sea-ray-slx-230-stk-41740'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/get_vessel_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### get_vessel_makes

Get the list of available vessel makes for use as filter values in list_vessel_listings. Each make includes a slug, display name, and listing count.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/get_vessel_makes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_vessel_types

Get the list of available vessel types for use as filter values in list_vessel_listings. Each type includes a slug, display name, and listing count.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/get_vessel_types \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_featured_listings

List featured vessel listings, sorted by featured status. Returns up to 18 items. These are premium listings highlighted by the platform.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/list_featured_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_live_auctions

List currently active live auction vessel listings. Count varies based on active auctions. Returns only vessels with active bidding.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/list_live_auctions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_recently_listed

List the most recently added vessel listings, sorted by date descending. Returns up to 18 items.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/list_recently_listed \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_vessel_listings

List vessel listings with pagination and filters. Returns up to 18 items per page. Supports filtering by make, vessel type, live auction status, text search, and sorting. Paginates via zero-based page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `live_auctions` | boolean | No | Set to true to show only live auction listings. Omission shows all listings. |
| `make` | string | No | Filter by vessel make slug from get_vessel_makes (e.g. 'sea-ray', 'bayliner'). |
| `page` | integer | No | Zero-based page number. Each page returns up to 18 items. |
| `query` | string | No | Free-text keyword to search vessel titles and descriptions. |
| `sort_by` | string | No | Sort option slug. |
| `vessel_type` | string | No | Filter by vessel type slug from get_vessel_types (e.g. 'center-console', 'cruiser'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/list_vessel_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"live_auctions":"<boolean>","make":"<string>","page":"<integer>","query":"<string>","sort_by":"<string>","vessel_type":"<string>"}'
```

### search_vessels

Search for vessels by keyword. Matches against vessel titles and descriptions. Returns all matching results in a single page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword matching vessel titles and descriptions (e.g. 'Sea Ray', 'Sundancer', 'Fountain'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yachtauctions-com-api-6de8dd22/search_vessels \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```