Get Auctions

Retrieve paginated auction listings with filtering and sorting options.

GET

Authentication

This endpoint requires authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Response

application/json

Auctions retrieved successfully

Request Parameters

FieldTypeRequiredDescription
Authorizationheader
Required
Bearer token with your API key: Bearer YOUR_API_KEY
makestring
Required
Make name (e.g., "Toyota"). Minimum length: 1 character.
modelstring-Model name to filter by
year_mininteger-Minimum year filter (inclusive)
year_maxinteger-Maximum year filter (inclusive)
price_mininteger-Minimum price filter (inclusive)
price_maxinteger-Maximum price filter (inclusive)
statusenum-Auction status filter. Options: "sold", "bid to", "reserve not met", "canceled", "unknown"
sourcestring-Source platform filter (e.g., "bringatrailer")
keywordstring-Search keyword to match in title and description (case-insensitive)
sortenum-Sort field. Options: "date" (default), "price", "year", "bids"
directionenum-Sort direction. Options: "asc", "desc" (default)
pageinteger-Page number for pagination. Minimum: 1, default: 1
limitinteger-Number of results per page. Range: 1-100, default: 50

Success Response Fields (200)

FieldTypeRequiredDescription
dataarray<object>
Required
Array of auction objects
data[].idnumber
Required
Unique auction identifier
data[].sourcestring | null-Source platform name
data[].urlstring | null-URL to the auction listing
data[].titlestring | null-Auction listing title
data[].auction_statusenum-Auction status: "sold", "bid to", "reserve not met", "canceled", "unknown"
data[].pricenumber | null-Final sale price or bid amount
data[].auction_end_datestring | null-Auction end date (YYYY-MM-DD format)
data[].mileagenumber | null-Vehicle mileage
data[].vinstring | null-Vehicle identification number
data[].title_statusstring | null-Title status (e.g., "clean", "salvage")
data[].citystring | null-Vehicle location city
data[].statestring | null-Vehicle location state
data[].zipstring | null-Vehicle location ZIP code
data[].seller_usernamestring | null-Seller username
data[].yearnumber | null-Vehicle model year
data[].listing_makestring | null-Make name from listing
data[].listing_modelstring | null-Model name from listing
data[].ocd_make_namestring | null-Normalized make name
data[].ocd_model_namestring | null-Normalized model name
data[].enginestring | null-Engine specification
data[].drivetrainstring | null-Drivetrain type
data[].transmissionstring | null-Transmission type
data[].body_stylestring | null-Vehicle body style
data[].exterior_colorstring | null-Exterior color as listed
data[].standard_exterior_colorstring | null-Normalized exterior color
data[].interior_colorstring | null-Interior color as listed
data[].standard_interior_colorstring | null-Normalized interior color
data[].seller_typestring | null-Seller type (e.g., "private", "dealer")
data[].descriptionstring | null-Listing description text
data[].ownership_historystring | null-Ownership history information
data[].modificationsarray<string>-Array of modification descriptions
data[].known_flawsarray<string>-Array of known flaw descriptions
data[].recent_service_historyarray<string>-Array of recent service history entries
data[].listing_detailsarray<string>-Array of listing detail strings
data[].created_atstring | null-Record creation timestamp (ISO 8601 format)
data[].statsobject
Required
Auction engagement statistics
data[].stats.viewsnumber | null-Number of views
data[].stats.watchesnumber | null-Number of watchers
data[].stats.likesnumber | null-Number of likes/comments
data[].stats.bidsnumber | null-Number of bids
metaobject
Required
Pagination metadata
meta.totalnumber
Required
Total number of matching auctions
meta.pagenumber
Required
Current page number
meta.limitnumber
Required
Number of results per page
meta.total_pagesnumber
Required
Total number of pages

Error Response Fields

FieldTypeRequiredDescription
errorstring
Required
Error type identifier. Common values: "Validation Error", "HTTP Error", "Database Error", "Internal Server Error"
messagestring
Required
Human-readable error message describing what went wrong
detailsobject<string, string[]>-Additional validation error details. Only present for 400 Validation Error responses. Keys are field names, values are arrays of error messages for that field