# Auctiontime — 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 equipment and truck auction listings from AuctionTime.com, view detailed information about specific auctions, filter by category and auctioneer, and track auction results by date. Access comprehensive auction data including listings, categories, and auctioneer information all in one place.

**Category:** Marketplaces | **Website:** [auctiontime.com/](https://auctiontime.com/) | **Docs:** [parse.bot/marketplace/608ff72c-1be8-456e-afd4-cb9e07b4976b/auctiontime-com-api](https://parse.bot/marketplace/608ff72c-1be8-456e-afd4-cb9e07b4976b/auctiontime-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-auctiontime-com-api-608ff72c/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_all_pages

Fetch listings across multiple pages (up to 7) for a category in a single request. Returns all collected listings with total_pages and pages_fetched counts.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Category ID. |
| `slug` | string | Yes | URL slug for the category. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_all_pages \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","slug":"<string>"}'
```

### get_auction_by_date

Fetch all upcoming auction listings for a specific date. Returns paginated results of auctions ending on the given date.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | Yes | Auction date in YYYY-MM-DD format. |
| `page` | integer | No | Page number. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_auction_by_date \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>","page":"<integer>"}'
```

### get_auction_results

Fetch sold auction results for a category. Returns completed/sold listing data including sold prices when available.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Category ID. |
| `page` | integer | No | Page number. |
| `slug` | string | Yes | URL slug for the category. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_auction_results \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","page":"<integer>","slug":"<string>"}'
```

### get_auctioneer_listings

Fetch active listings for a specific auctioneer by their URL slug. Use get_auctioneers to discover valid slugs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `auctioneer_slug` | string | Yes | Auctioneer URL slug (e.g., 'auctionblock', 'dagger-machinery'). |
| `page` | integer | No | Page number. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_auctioneer_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"auctioneer_slug":"<string>","page":"<integer>"}'
```

### get_auctioneers

Fetch a paginated list of auctioneers with contact info, location, and items sold count.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_auctioneers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### get_categories

Fetch top-level auction categories with their IDs and URL slugs. These category IDs and slugs are used as inputs to get_listings, get_all_pages, and get_auction_results.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_categories \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_listing_detail

Fetch full detail for a single auction listing by its ID. Returns title, description, category, specs, current bid, sale end time, location, images, and other metadata.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | Numeric listing ID (e.g. '255572897'). |
| `slug` | string | No | URL slug for the listing. Defaults to 'item' if unknown. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_listing_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>","slug":"<string>"}'
```

### get_listings

Fetch paginated auction listings for a category. Returns up to 28 listings per page with title, location, lot number, specs, and image. Use get_categories to discover valid slug/category_id pairs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Category ID (e.g., '1100' for tractors, '27' for trucks). |
| `page` | integer | No | Page number. |
| `slug` | string | Yes | URL slug for the category (e.g., 'tractors', 'trucks', 'trailers'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/get_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","page":"<integer>","slug":"<string>"}'
```

### search_listings

Search auction listings by keyword. Returns paginated results matching the query across all categories.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `query` | string | Yes | Search keyword (e.g., 'John Deere', 'excavator'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-auctiontime-com-api-608ff72c/search_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","query":"<string>"}'
```
