/carsandbids/auctions/search

POST /api/carsandbids/auctions/search

Price: 5 credits

Search Cars & Bids auctions, live or ended, by make, model, model-year range, body style, transmission and notable flag, with the site's sort orders. Returns auction cards with title, subtitle, location, mileage, current bid, sale price, end time, seller and photos.

How to use it

Search Cars & Bids auctions; status is required (live or ended) and ended covers the full results archive. make and model take the slugs from Cars & Bids URLs, such as porsche and cayenne. Pass an id to carsandbids/auctions for the full listing or to carsandbids/auctions/comments for its thread.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• status string required — live: auctions open for bidding; ended: closed auctions (sold or not) (one of: "live", "ended")
• make string nullable — Make slug as used in Cars & Bids URLs (examples: "porsche"; minLength: 1)
• model string nullable — Model slug as used in Cars & Bids URLs; requires make (examples: "cayenne"; minLength: 1)
• year_min integer nullable — Earliest model year (min: 1900; max: 2100)
• year_max integer nullable — Latest model year (min: 1900; max: 2100)
• body_style string nullable — Body style (one of: "coupe", "convertible", "hatchback", "sedan", "suv_crossover", "truck", "van_minivan", "wagon")
• transmission string nullable — Transmission type (one of: "automatic", "manual")
• only_notable boolean — Only auctions Cars & Bids marks as notable (default: false)
• sort string nullable — Order. live: ending_soon, newly_listed, no_reserve, lowest_mileage. ended: recently_ended, lowest_mileage, highest_mileage, lowest_price, highest_price. Defaults to ending_soon for live and recently_ended for ended (one of: "ending_soon", "newly_listed", "no_reserve", "recently_ended", "lowest_mileage", "highest_mileage", "lowest_price", "highest_price")
• count integer required — Max number of auctions to return (min: 1)

Response

• @type string (default: "CarsandbidsAuctionCard")
• id string required
• url string required
• submission_id string nullable
• sub_title string nullable
• featured_sub_title string nullable
• status string nullable
• location string nullable
• mileage_text string nullable
• transmission string nullable
• is_no_reserve boolean nullable
• has_inspection boolean nullable
• is_featured boolean nullable
• is_notable boolean nullable
• current_bid number nullable
• sale_price number nullable
• ends_at integer nullable
• seller object nullable
  • @type string (default: "CarsandbidsUser")
  • id string nullable
  • alias string required
  • url string required
  • image string nullable
  • is_certified_seller boolean nullable
  • is_seller boolean nullable
  • is_bidder boolean nullable
  • is_verified boolean nullable
  • is_staff boolean nullable
  • reputation integer nullable
  • follower_count integer nullable
• image string nullable
• images array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No Cars & Bids make or model exists at this slug. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.