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

> Auction provides 11 callable API endpoints through the Parse marketplace.

**Category:** Real Estate | **Website:** [auction.com/](https://auction.com/) | **Docs:** [parse.bot/marketplace/8cabd06f-495a-4a03-a247-99421bac05f9/auction-com-api](https://parse.bot/marketplace/8cabd06f-495a-4a03-a247-99421bac05f9/auction-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-auction-com-api-8cabd06f/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_auction_calendar

Retrieve upcoming auction calendar events with venue details and listing counts. Returns paginated results sorted by campaign start date. Each event includes its event_code, type (LIVE or ONLINE), title, total listing count, and venue schedule information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page |
| `offset` | integer | No | Pagination offset |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_auction_calendar \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>"}'
```

### get_auction_event_details

Get listings for a specific auction event by event code. Returns paginated property listings within the event, with the same listing detail shape as search results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `event_id` | string | Yes | Event code (e.g. 'O-1608', 'E-900Z'). Obtain from get_auction_calendar endpoint's content[*].event_code field. |
| `limit` | integer | No | Max results per page |
| `offset` | integer | No | Pagination offset |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_auction_event_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"<string>","limit":"<integer>","offset":"<integer>"}'
```

### get_autocomplete_suggestions

Get location autocomplete suggestions for cities, counties, states, and ZIP codes matching the search text. Returns coordinates and location type classification for each result.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search text for location autocomplete (e.g. 'Miami', 'Los Angeles', '90210') |

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

### get_bank_owned_listings

Search for active bank-owned and foreclosure property listings. Returns paginated results with the same listing shape as search_properties.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page |
| `location` | string | No | State code (e.g. 'CA', 'TX') or free-text search location |
| `offset` | integer | No | Pagination offset |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_bank_owned_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","location":"<string>","offset":"<integer>","sort":"<string>"}'
```

### get_foreclosure_listings

Search for active property listings filtered to foreclosure and bank-owned properties. Returns the same paginated result shape as search_properties, scoped to foreclosure asset types.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page |
| `location` | string | No | State code (e.g. 'CA', 'TX') or free-text search location |
| `offset` | integer | No | Pagination offset |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_foreclosure_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","location":"<string>","offset":"<integer>","sort":"<string>"}'
```

### get_market_analysis

Get market analysis and valuation estimates for a currently active property listing. Returns rental and composite value estimates with low/high ranges. Comparables may be null for unauthenticated requests. Requires an active listing ID.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | Listing ID of a currently active property (e.g. '2092411') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_market_analysis \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>"}'
```

### get_private_seller_listings

Search for active private seller and other property listings. Returns paginated results with the same listing shape as search_properties.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page |
| `location` | string | No | State code (e.g. 'CA', 'TX') or free-text search location |
| `offset` | integer | No | Pagination offset |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_private_seller_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","location":"<string>","offset":"<integer>","sort":"<string>"}'
```

### get_property_details

Get full details for a specific property listing including photos, documents, remarks, venue info, and recommended similar listings. Requires either listing_id or url_slug. Returns detailed auction info, listing configuration, property summary with address coordinates, and documents.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | No | Listing ID (e.g. '2092411') |
| `url_slug` | string | No | URL slug from listing page path; listing ID is extracted from the end (e.g. '11771-hazeldell-dr-riverside-ca-2092411') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_property_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>","url_slug":"<string>"}'
```

### get_property_photos

Get photo CDN URLs for a property listing. Requires either listing_id or url_slug. Returns an array of image URLs. Some listings may have zero photos.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | No | Listing ID (e.g. '2092073') |
| `url_slug` | string | No | URL slug from listing page path; listing ID is extracted from the end |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_property_photos \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>","url_slug":"<string>"}'
```

### get_similar_properties

Get recommended similar properties for a given listing. Requires either listing_id or url_slug. Returns listings near the same location with similar characteristics. Some listings may not have similar properties available.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | No | Listing ID (e.g. '2092411') |
| `url_slug` | string | No | URL slug from listing page path; listing ID is extracted from the end |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/get_similar_properties \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>","url_slug":"<string>"}'
```

### search_properties

Search for property listings on Auction.com. Returns paginated results with listing details including address, auction dates, pricing, and property summaries. Supports filtering by state code or free-text location. Each result includes auction timing, valuation estimates, and property configuration.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max results per page |
| `listing_type` | string | No | Listing type filter (e.g. 'active') |
| `location` | string | No | State code (e.g. 'CA', 'TX') or free-text search location |
| `offset` | integer | No | Pagination offset |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auction-com-api-8cabd06f/search_properties \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","listing_type":"<string>","location":"<string>","offset":"<integer>","sort":"<string>"}'
```