/ritchiebros/auctions

POST /api/ritchiebros/auctions

Price: 20 credits

List upcoming Ritchie Bros. auctions from the rbauction.com calendar: name, dates, format, item count, location, catalog links and the yards the items sit in.

How to use it

Find which Ritchie Bros. auctions are coming up and how many lots each carries. Pass an auction's id as auction_id to ritchiebros/listings/search to list its lots.

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 auctions to return (min: 1; max: 300)

Response

• @type string (default: "RitchiebrosAuction")
• id string required
• sale_number string nullable
• name string nullable
• auction_type string nullable
• selling_method string nullable
• ways_to_participate string nullable
• operation_status string nullable
• scheduling_status string nullable
• item_count integer nullable
• total_days integer nullable
• starts_at integer nullable
• ends_at integer nullable
• bidding_ends_at integer nullable
• online_bidding_enabled_at integer nullable
• time_zone string nullable
• classification string nullable
• additional_classifications array (default: [])
• country string nullable
• region string nullable
• locality string nullable
• location_level_one string nullable
• location_level_two string nullable
• location_level_three string nullable
• consignor_name string nullable
• image string nullable
• thumbnail string nullable
• catalog_pdf_url string nullable
• brochure_url string nullable
• advance_notice_url string nullable
• is_online_bidding_enabled boolean nullable
• is_priority_bidding_enabled boolean nullable
• is_enter_auction_visible boolean nullable
• is_marketplace_enabled boolean nullable
• is_registration_enabled boolean nullable
• is_online_bidding_paused boolean nullable
• site_count integer nullable
• sites array (default: [])
  • @type string (default: "RitchiebrosAuctionSite")
  • id string nullable
  • name string nullable
  • city string nullable
  • state string nullable
  • country string nullable
  • item_count integer nullable
  • site_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.