> ## Documentation Index
> Fetch the complete documentation index at: https://docs.driv.ly/llms.txt
> Use this file to discover all available pages before exploring further.

# Auction Data

> Access auction insights, historical data, current listings, and sales results.

## Overview

The Auction API provides a centralized access point to leading auction platforms. This API allows you to connect comprehensive data from auction platforms, enabling detailed market analysis and informed decision-making.

| Capabilities                               | Description                                                                                            |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| [Available](#available-auctions)           | Retrieves a list of available auctions users can sign up to access.                                    |
| [Historical](#historical-auction-data)     | Accesses historical auction data for market analysis and valuation purposes.                           |
| [Inventory](#current-listings-at-auctions) | Retrieves current vehicle listings available for sale at various auctions.                             |
| [Sales](#auction-sales-results)            | Fetches results from recent auctions, including details like sale prices and vehicle specifications.   |
| [Scheduled](#run-lists-for-auctions)       | Provides the list of vehicles scheduled for sale on specified auction dates at various auction houses. |
| [Sell](#create-a-listing-for-auction)      | Allows users to list a vehicle for sale at an auction.                                                 |

<Info>
  Auction API requires credentials from an authorized and/or
  licensed user.
</Info>

***

## Available Auctions

Retrieves a list of available auctions users can sign up to access. This data includes auction names, locations, and registration requirements.

```json theme={null}
{
    {
      "name": "ABC Auction",
      "locations": [
        "Atlanta, GA",
        "Albany, NY",
        "Chicago, IL",
        "Dallas, TX",
        "Orlando, FL",
        ...
        ],
      "registrationRequired": true
    },
    {
      "name": "Acme Cars",
      "locations": "Online",
      "registrationRequired": true
    },
    {
      "name": "Wholesale America",
      "locations": [
        "Birmingham, AL",
        "Dallas, TX",
        "Minneapolis, MN",
        "Knoxville, TN",
        "Nashville, TN",
        "Tampa, FL",
        ...
        ],
      "registrationRequired": true
    }
}
```

***

## Historical Auction Data

Retrieve information about past auctions, including sale prices, bidding history, and vehicle condition reports.

```json theme={null}
{
  "startDate": "2023-01-01",
  "endDate": "2024-01-01",
  "auction": "Acme Cars",
  "historicalData": [
    {
      "vehicle": {
        "vin": "3MW5R7J02L8B34180",
        "year": 2020,
        "make": "BMW",
        "model": "3 Series",
        "trim": "330i xDrive"
      },
      "averageSalePrice": 28603
    },
    {
      "vehicle": {
        "vin": "WAUBFAFL7EA050567",
        "year": 2014,
        "make": "Audi",
        "model": "A4",
        "trim": "2.0T Premium quattro"
      },
      "averageSalePrice": 13995
    },
    ...
  ]
}
```

***

## Current Listings at Auctions

Retrieves current vehicle listings available for sale at various auctions. This data includes vehicle details, listing prices, and auction house information.

```json theme={null}
{
  "auctionHouse": "ABC Auction Nashville",
  "listings": [
    {
      "listingId": "003",
      "vehicle": {
        "vin": "1FTFW1RG9JFD77911",
        "year": 2018,
        "make": "Ford",
        "model": "F-150",
        "trim": "Raptor"
      },
      "buyNowPrice": 45000,
      "minimumBid": 40000
    },
    ...
  ]
}
```

***

## Auction Sales Results

Fetches results from recent auctions, including sale prices, vehicle specifications, and sale status.

```json theme={null}
{
  "auctionDate": "2024-04-15",
  "auctionHouse": "ABC Auction Nashville",
  "results": [
    {
      "vehicle": {
        "vin": "5FNYF6H51MB089458",
        "year": 2021,
        "make": "Honda",
        "model": "Pilot",
        "trim": "EX-L"
      },
      "salePrice": 32998,
      "status": "Sold"
    },
    {
      "vehicle": {
        "vin": "JTEBU5JR8J5590715",
        "year": 2018,
        "make": "Toyota",
        "model": "4Runner",
        "trim": "SR5 Premium"
      },
      "salePrice": 28995,
      "status": "Sold"
    },
    ...
  ]
}
```

***

## Run Lists for Auctions

View upcoming auctions and the vehicles scheduled to be auctioned. This data includes auction dates, auction houses, and vehicle details.

```json theme={null}
{
  "auctionDate": "2024-04-30",
  "auctionHouse": "ABC Auction Nashville",
  "vehicles": [
    {
      "vin": "1FMSK8FH8NGA62805",
      "year": 2022,
      "make": "Ford",
      "model": "Explorer",
      "trim": "Limited",
      "startingBid": 36000,
      "buyNowPrice": 42000,
      "minimumBid": 35000
    },
    {
      "vin": "3GCPDAEK9RG290332",
      "year": 2024,
      "make": "Chevrolet",
      "model": "Silverado 1500",
      "trim": "Work Truck",
      "startingBid": 39500,
      "buyNowPrice": 45000,
      "minimumBid": 38000
    },
    ...
  ]
}
```

***

## Create a Listing for Auction

Allows users to list a vehicle for sale at an auction. Users can provide details about the vehicle, the auction house, and the listing price.

This endpoint creates a new listing and returns a confirmation message with the listing details.

```json theme={null}
{
  "success": true,
  "message": "Listing created successfully.",
  "vin": "1FTEW1EP6KKD71896",
  "listingId": "00256018",
  "auction": "ABC Auction",
  "location": "Palm Beach, FL",
  "auctionHouse": "ABC Auction Plam Peach",
  "startingBid": 25000,
  "minimumBid": 20000,
  "bidIncrement": 500
}
```