/copart/auctions/search

POST /api/copart/auctions/search

Price: 10 credits

List the scheduled Copart online sales from the auction calendar: sale name, start time, time zone, platform and the yards whose lots run in each sale.

How to use it

See which Copart sales run next and when, to time a bid. Each sale lists its yard numbers; pass one to copart/locations for the yard's address and hours.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of sales to return (min: 1)

Response

• @type string (default: "CopartAuction")
• id string required
• name string nullable
• sale_platform string nullable
• sale_type string nullable
• starts_at integer nullable
• next_sale_at integer nullable
• auction_date_at integer nullable
• start_time string nullable
• display_time string nullable
• time_zone string nullable
• pre_bid_ends_before string nullable
• yard_number integer nullable
• brand string nullable
• is_live boolean nullable
• is_virtual_yard boolean nullable
• yards array (default: [])
  • @type string (default: "CopartAuctionYard")
  • number integer required
  • name string nullable
  • sale_type 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.