/bringatrailer/listings/search

POST /api/bringatrailer/listings/search

Price: 1 credit

Search Bring a Trailer completed auction results by keyword, excluded keyword and model-year range, newest first. Returns result cards with title, excerpt, final or high bid, currency, result text, end time, country, comment, view and watcher counts and thumbnail.

How to use it

Search Bring a Trailer's completed auction results (sold, bid-to and withdrawn), newest first. Use keyword and exclude_keyword to narrow by text and year_min/year_max by model year; pass a result's alias to bringatrailer/listings or bringatrailer/listings/comments.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Only results matching this text (examples: "porsche 911"; minLength: 1)
• exclude_keyword string nullable — Leave out results matching this text (examples: "turbo"; minLength: 1)
• year_min integer nullable — Earliest model year (min: 1886; max: 2100)
• year_max integer nullable — Latest model year (min: 1886; max: 2100)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "BringatrailerListingCard")
• id string required
• alias string nullable
• url string required
• description string nullable
• is_no_reserve boolean nullable
• is_premium boolean nullable
• is_repeat boolean nullable
• current_bid number nullable
• currency string nullable
• result_text string nullable
• ends_at integer nullable
• country_code string nullable
• image string nullable

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 — The entity was not found, or a precondition failed 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.